Share via

Upland Panviva US (Preview)

Upland Panviva enhances knowledge management for complex, regulated industries by providing AI-powered, real-time guidance for agents and customers. Our expert solutions ensure compliance and competitiveness, tailored for healthcare, banking, utilities, and BPO organizations with large contact centers. From compliance-focused manual management to fully integrated AI guidance, Panviva adapts to your needs. Boost productivity and maintain compliance standards backed by industry expertise.

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Upland Panviva Support
URL https://uplandsoftware.com/panviva/support/
Email support@uplandsoftware.com
Connector Metadata
Publisher Upland Software Inc..
Website https://uplandsoftware.com/panviva
Privacy policy https://uplandsoftware.com/privacy
Categories Data;Marketing

Panviva Connector

Upland Panviva enhances knowledge management for complex, regulated industries by providing AI-powered, real-time guidance for agents and customers. Our expert solutions ensure compliance and competitiveness, tailored for healthcare, banking, utilities, and BPO organizations with large contact centers. From compliance-focused manual management to fully integrated AI guidance, Panviva adapts to your needs. Boost productivity and maintain compliance standards backed by industry expertise.

Prerequisites

You will need the following to proceed:

  • A Microsoft Power Apps or Power Automate plan with custom connector feature
  • A Panviva subscription tier that includes APIs

Building the connector

Since the Panviva APIs are secured, you will need:

  1. Access to a Panviva instance (also known as a tenant)
  2. A developer account on the Panviva developer portal US-[https://dev.panviva.com] AU-(https://dev.panviva.com)
  3. An active Panviva API subscription (also known as an API plan) and valid Panviva API credentials

After that is completed, you can create and test the connector.

Supported Actions

The Panviva connector supports the following actions:

  • Search Operations
    • Search: Search documents, folders, and files (external documents) for a term and return paginated results
    • Search Artefacts: Return Digital Orchestrator search results for a given query
  • Live Operations
    • 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
  • Document Operations
    • Document: Return a document using the document ID provided
    • Document Containers: Return a list of containers using the document ID provided
    • Document Container Relationships: Return a list of the parent-child relationship between each container for the document ID provided
    • Container: Return a container using the container ID provided
    • Document Translations: Return a list of all translations (per language and locale) of a Panviva document
  • Resource Operations
    • Artefact: Return a Digital Orchestrator artefact using the ID provided
    • Get Artefact Categories: Gets a list of all available artefact categories
    • File: Retrieve 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 Translations: Gets all the translations of a Panviva folder, along with each translated folders respective children
    • 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
    • Image: Returns an image from Panviva. Image data is represented as a base64 string
  • Create Operations
    • Publish Artefact: Updates an already published Digital Orchestrator artefact
    • Create Artefact Category: Creates a category for classifying Digital Orchestrator artefacts
    • Create Artefact: Creates a new Digital Orchestrator artefact

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
api_key securestring The api_key for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Artefact

Return a Digital Orchestrator artefact using the ID provided.
Container

Return a document container using the container ID provided.
Create Artefact

Creates a new Digital Orchestrator artefact with content, metadata, and category information. Artefacts are reusable content pieces that can be delivered through various channels within Panviva.
Create Artefact Category

Creates a new category for classifying Digital Orchestrator artefacts. Categories help organize artefacts by topic, department, or any other classification system relevant to your organization.
Document

Return a document using the document ID provided.
Document Container Relationships

Retrieves the hierarchical structure of a document by returning the parent-child relationships between all containers (sections and subsections) within the document. This helps understand how content is organized.
Document Containers

Retrieves all containers (sections and subsections) within a specified document. Containers represent the hierarchical structure of content within a document.
Document Translations

Retrieves all available translations of a Panviva document across different languages and locales. This helps access multilingual versions of the same content.
Echo

Echo a request to verify connectivity with the Panviva API. This endpoint is useful for testing and debugging purposes.
File

Retrieves an external document (such as a PDF, Word document, or other file type) that has been uploaded to Panviva. The file content is returned as a base64-encoded string.
Folder

Retrieves information about a specific Panviva folder, including its metadata and links to its direct children. Folders are used to organize documents and files in a hierarchical structure.
Folder Children

Retrieves all immediate children (direct contents) of a specific Panviva folder. This includes subfolders, documents, and files (external documents) that are directly contained within the specified folder, but does not include items in nested subfolders.
Folder Root

Retrieves the top-level home folder in Panviva, which serves as the starting point for navigating the entire content hierarchy. This root folder contains links to its direct children, which can be accessed using the Get Folder Children endpoint to traverse the folder structure.
Folder Translations

Retrieves all available translations of a specific Panviva folder across different languages and locales. This includes metadata for each translated version of the folder and links to access their respective children.
Get Artefact Category

Retrieves a list of all available categories for classifying Digital Orchestrator artefacts. These categories help organize artefacts and can be used for filtering and navigation.
Image

Retrieves a specific image stored in Panviva. The image data is returned as a base64-encoded string which can be decoded and displayed in applications or saved as an image file.
Live CSH

Presents a context-sensitive help (CSH) search result page to a specified user in their Panviva client. This operation allows you to push search results directly to a user's screen.
Live Document

Pushes a specific document or document section directly to a specified user's Panviva client. This allows you to display relevant documentation to users in real-time as they work.
Live Search

Present a search result page of the passing query on Panviva client to specified user on Panviva client in real time.
Publish Artefact

Updates an existing Digital Orchestrator artefact with new content, metadata, or category information. This operation is used to modify artefacts that have already been published.
Search

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

Returns Digital Orchestrator search results for a given natural language or advanced query. This endpoint allows searching through artefacts using various query methods and filtering options.

Artefact

Operation ID:
ResourcesArtefactById

Return a Digital Orchestrator artefact using the ID provided.

Parameters

Name Key Required Type Description
Instance Name
 instance True string

The instance name as shown on the Panviva Developer Portal.
Artefact ID
 id True string

Format - uuid. The id (ID) of the Digital Orchestrator artefact.

Returns

The response from the Panviva API containing enriched response data.

Body
GetEnrichedResponseResponse

Container

Operation ID:
ResourcesContainerById

Return a document container using the container ID provided.

Parameters

Name Key Required Type Description
Instance Name
 instance True string

The instance name as shown on the Panviva Developer Portal.
Container ID
 id True string

The ID of a document container.

Returns

The response from the Panviva API containing container data.

Body
GetContainerResponse

Create Artefact

Operation ID:
ResourcesCreateArtefact

Creates a new Digital Orchestrator artefact with content, metadata, and category information. Artefacts are reusable content pieces that can be delivered through various channels within Panviva.

Parameters

Name Key Required Type Description
Instance Name
 instance True string

The instance name as shown on the Panviva Developer Portal.
Save as Draft
 isDraft boolean

Indicates whether to save the artefact as a draft (true) or publish it immediately (false). Draft artefacts are not visible to end users until published.
title
 title string

The title of the artefact to be created.
mediaType
 mediaType string

The MIME type of the content in this section (e.g., text/plain, image/jpeg).
text
 text string

The text content for this section, if applicable.
source
 source string

The source reference for this content if it comes from external material.
resourceLocation
 resourceLocation string

Indicates whether the resource is stored internally or externally (values: internal, external, null).
mediaType
 mediaType string

The media type of the content (e.g., 'text/html', 'text/plain').
text
 text string

The text content of the section.
href
 href string

A hyperlink to additional content or resources.
resourceLocation
 resourceLocation string

The location of the resource, typically a URL or file path.
id
 id integer

The unique identifier for the channel.
name
 name string

The name of the channel for content delivery.
id
 id integer

The unique identifier of the category to associate with the artefact.
primaryQuery
 primaryQuery string

The main query text that this artefact is designed to answer.
query
 query string

The search query text.
panvivaDocumentId
 panvivaDocumentId integer

The ID of a related Panviva document, if this artefact is linked to one.
panvivaDocumentVersion
 panvivaDocumentVersion integer

The version of the related Panviva document.
metaData
 metaData object

Returns

The response from the Panviva API after creating a new artefact.

Body
PostArtefactResponse

Create Artefact Category

Operation ID:
ResourcesArtefactCategoryPost

Creates a new category for classifying Digital Orchestrator artefacts. Categories help organize artefacts by topic, department, or any other classification system relevant to your organization.

Parameters

Name Key Required Type Description
Instance Name
 instance True string

The instance name as shown on the Panviva Developer Portal.
name
 name string

The name of the artefact category to be created.

Returns

The response from the Panviva API after creating a new artefact category.

Body
PostArtefactCategoryResponse

Document

Operation ID:
ResourcesDocumentById

Return a document using the document ID provided.

Parameters

Name Key Required Type Description
Instance Name
 instance True string

The instance name as shown on the Panviva Developer Portal.
Document 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.
Document Version
 version integer

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

Returns

The response from the Panviva API containing document data.

Body
GetDocumentResponse

Document Container Relationships

Operation ID:
ResourcesDocumentContainersByIdRelationships

Retrieves the hierarchical structure of a document by returning the parent-child relationships between all containers (sections and subsections) within the document. This helps understand how content is organized.

Parameters

Name Key Required Type Description
Instance Name
 instance True string

The instance name as shown on the Panviva Developer Portal.
Document ID
 id True integer

The internal ID (IID) of the Panviva document whose structure you want to retrieve.

Returns

The response from the Panviva API containing document container relationships.

Body
GetDocumentContainerRelationshipsResponse

Document Containers

Operation ID:
ResourcesDocumentByIdContainers

Retrieves all containers (sections and subsections) within a specified document. Containers represent the hierarchical structure of content within a document.

Parameters

Name Key Required Type Description
Instance Name
 instance True string

The instance name as shown on the Panviva Developer Portal.
Document ID
 id True integer

The internal ID (IID) of the Panviva document whose containers you want to retrieve.
Document Version
 version integer

The specific version of the document whose containers you want to retrieve. If omitted, the latest version's containers will be returned.

Returns

The response from the Panviva API containing document container data.

Body
GetDocumentContainersResponse

Document Translations

Operation ID:
ResourcesDocumentByIdTranslations

Retrieves all available translations of a Panviva document across different languages and locales. This helps access multilingual versions of the same content.

Parameters

Name Key Required Type Description
Instance Name
 instance True string

The instance name as shown on the Panviva Developer Portal.
Document ID
 id True integer

The internal ID (IID) of the original Panviva document for which you want to retrieve translations.

Returns

The response from the Panviva API containing document translation data.

Body
GetDocumentTranslationsResponse

Echo

Operation ID:
Echo

Echo a request to verify connectivity with the Panviva API. This endpoint is useful for testing and debugging purposes.

Parameters

Name Key Required Type Description
Instance Name
 instance True string

The instance name as shown on the Panviva Developer Portal.

File

Operation ID:
ResourcesFileById

Retrieves an external document (such as a PDF, Word document, or other file type) that has been uploaded to Panviva. The file content is returned as a base64-encoded string.

Parameters

Name Key Required Type Description
Instance Name
 instance True string

The instance name as shown on the Panviva Developer Portal.
File ID
 id True integer

The internal ID (IID) of the Panviva file (external document) to retrieve.

Returns

The response from the Panviva API containing file data.

Body
GetFileResponse

Folder

Operation ID:
ResourcesFolderById

Retrieves information about a specific Panviva folder, including its metadata and links to its direct children. Folders are used to organize documents and files in a hierarchical structure.

Parameters

Name Key Required Type Description
Instance Name
 instance True string

The instance name as shown on the Panviva Developer Portal.
Folder ID
 id True integer

The internal ID (IID) of the Panviva folder to retrieve.

Returns

The response from the Panviva API containing folder data.

Body
GetFolderResponse

Folder Children

Operation ID:
ResourcesFolderByIdChildren

Retrieves all immediate children (direct contents) of a specific Panviva folder. This includes subfolders, documents, and files (external documents) that are directly contained within the specified folder, but does not include items in nested subfolders.

Parameters

Name Key Required Type Description
Instance Name
 instance True string

The instance name as shown on the Panviva Developer Portal.
Folder ID
 id True integer

The internal ID (IID) of the Panviva folder whose contents you want to retrieve.

Returns

The response from the Panviva API containing folder children data.

Body
GetFolderChildrenResponse

Folder Root

Operation ID:
ResourcesFolderRoot

Retrieves the top-level home folder in Panviva, which serves as the starting point for navigating the entire content hierarchy. This root folder contains links to its direct children, which can be accessed using the Get Folder Children endpoint to traverse the folder structure.

Parameters

Name Key Required Type Description
Instance Name
 instance True string

The instance name as shown on the Panviva Developer Portal.

Returns

The response from the Panviva API containing root folder data.

Body
GetFolderRootResponse

Folder Translations

Operation ID:
ResourcesFolderByIdTranslations

Retrieves all available translations of a specific Panviva folder across different languages and locales. This includes metadata for each translated version of the folder and links to access their respective children.

Parameters

Name Key Required Type Description
Instance Name
 instance True string

The instance name as shown on the Panviva Developer Portal.
Folder ID
 id True integer

The internal ID (IID) of the original Panviva folder for which you want to retrieve translations.

Returns

The response from the Panviva API containing folder translation data.

Body
GetFolderTranslationsResponse

Get Artefact Category

Operation ID:
ResourcesArtefactCategoriesGet

Retrieves a list of all available categories for classifying Digital Orchestrator artefacts. These categories help organize artefacts and can be used for filtering and navigation.

Parameters

Name Key Required Type Description
Instance Name
 instance True string

The instance name as shown on the Panviva Developer Portal.

Returns

The response from the Panviva API containing artefact category data.

Body
GetArtefactCategoriesResponse

Image

Operation ID:
ResourcesImageById

Retrieves a specific image stored in Panviva. The image data is returned as a base64-encoded string which can be decoded and displayed in applications or saved as an image file.

Parameters

Name Key Required Type Description
Instance Name
 instance True string

The instance name as shown on the Panviva Developer Portal.
Image ID
 id True integer

The unique identifier of the Panviva image to retrieve.

Returns

The response from the Panviva API containing image data.

Body
GetImageResponse

Live CSH

Operation ID:
OperationsLiveCsh

Presents a context-sensitive help (CSH) search result page to a specified user in their Panviva client. This operation allows you to push search results directly to a user's screen.

Parameters

Name Key Required Type Description
Instance Name
 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

The response from the Panviva API after sending a live CSH request.

response
object

Live Document

Operation ID:
OperationsLiveDocument

Pushes a specific document or document section directly to a specified user's Panviva client. This allows you to display relevant documentation to users in real-time as they work.

Parameters

Name Key Required Type Description
Instance Name
 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. Note: Use location OR containerId, not both.)
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.
containerId
 containerId string

The Id of the Container you'd like the user to see when the specified document is opened. (Note: Use location OR containerId, not both.)

Returns

The response from the Panviva API after sending a live document request.

response
object
Operation ID:
OperationsLiveSearch

Present a search result page of the passing query on Panviva client to specified user on Panviva client in real time.

Parameters

Name Key Required Type Description
Instance Name
 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

The response from the Panviva API after sending a live search request.

response
object

Publish Artefact

Operation ID:
PublishArtefact

Updates an existing Digital Orchestrator artefact with new content, metadata, or category information. This operation is used to modify artefacts that have already been published.

Parameters

Name Key Required Type Description
Instance Name
 instance True string

The instance name as shown on the Panviva Developer Portal.
Artefact ID
 id True string

The unique identifier (UUID format) of the artefact to update.
id
 id uuid

The unique identifier of the artefact to be updated.
primaryResponse
 primaryResponse string

The primary response content for the artefact.
panvivaDocumentVersion
 panvivaDocumentVersion integer

The version number of the Panviva document associated with this artefact.
mediaType
 mediaType string

The MIME type of the content in this section (e.g., text/plain, image/jpeg).
text
 text string

The text content for this section, if applicable.
source
 source string

The source reference for this content if it comes from external material.
resourceLocation
 resourceLocation string

Indicates whether the resource is stored internally or externally (values: internal, external, null).
sectionId
 sectionId string

The unique identifier of the tagged section.
hash
 hash string

A hash value representing the content of the tagged section.
id
 id integer

The unique identifier of the category to associate with the artefact.
panvivaDocumentId
 panvivaDocumentId string

The ID of the Panviva document associated with this artefact.
title
 title string

The title of the artefact.
primaryQuery
 primaryQuery string

The main query text that this artefact is designed to answer.
id
 id integer
query
 query string

The search query text.
metaData
 metaData object
id
 id integer

The unique identifier for the variation.
id
 id integer

The unique identifier for the channel.
name
 name string

The name of the channel for content delivery.
content
 content string

The content of the variation, typically in HTML format.

Returns

The response from the Panviva API after updating an artefact.

Body
PutArtefactResponse
Operation ID:
OperationsSearch

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

Parameters

Name Key Required Type Description
Instance Name
 instance True string

The instance name as shown on the Panviva Developer Portal.
Search Term
 term True string

The word or phrase to be searched for. Supports simple keywords, Lucene syntax, and regex patterns.
Page Offset
 pageOffset integer

The pagination offset to denote the number of initial search results to skip.
Page Limit
 pageLimit integer

The number of records to return. Must be an integer between 0 and 1000.
Changed When
 changedWhen string

Helper keywords for applying filters for documents updated in range.
Direct Parent Folder ID
 directParentFolderId integer

Search only within given Folder. Any documents in the sub folders are not searched. If not provided, resources are searched across all folders.

Returns

Name Path Type Description
results
 results array of object

The list of resources matching the search criteria.
type
 results.type string

The type of resource returned (e.g., 'document', 'folder', or 'file').
id
 results.id string

The unique identifier for the resource that can be used to retrieve its details.
name
 results.name string

The title or display name of the resource.
layout
 results.layout string

The page layout template used for the resource (e.g., 'topTabsMedium', 'leftTabsMedium').
description
 results.description string

A brief summary or description of the resource's contents.
classification
 results.classification string

The category or classification of the resource (e.g., 'films', 'books').
updatedDate
 results.updatedDate string

The date when the resource was last updated, in ISO 8601 format (YYYY-MM-DD).
matchedFields
 results.matchedFields array of string

The list of fields in which the search term was found (e.g., 'name', 'content').
snippet
 results.snippet string

A short excerpt from the content showing the search term in context, often with highlighting.
language
 results.language string

The language code of the resource (e.g., 'en-AU' for Australian English).
links
 results.links array of object

Hypermedia links related to this search result that can be used for further operations.
href
 results.links.href string

The URL to access the related resource or perform an operation.
rel
 results.links.rel string

The relationship type of the link to the current resource (e.g., 'document', 'file').
type
 results.links.type string

The HTTP method to use when accessing this link (typically 'GET').
total
 total integer

The total number of results matching the search criteria across all pages.
links
 links array of object

Pagination links that allow navigation between pages of search results.
href
 links.href string

The URL to access a specific page of search results.
rel
 links.rel string

The relationship of this link to the current page (e.g., 'first', 'last', 'next', 'prev').
type
 links.type string

The HTTP method to use when accessing this link (typically 'GET').

Search Artefacts

Operation ID:
OperationsArtefactNls

Returns Digital Orchestrator search results for a given natural language or advanced query. This endpoint allows searching through artefacts using various query methods and filtering options.

Parameters

Name Key Required Type Description
Instance Name
 instance True string

The instance name as shown on the Panviva Developer Portal.
Simple Query
 simplequery string

Natural language query string. For example: 'What action movie stars Peter Parker?'. (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 filter string written in OData expression syntax. Examples: category/name eq 'Mortgages', panvivaDocumentVersion gt '8'. (Filterable fields include 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

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.
Page Limit
 pageLimit integer

The number of records to return. Must be an integer between 0 and 1000.
Facet String
 facet string

Accepts a string denoting the field to facet by. Examples: facet=metaData/keyword/values, facet=category/name. (Facetable fields include metaData/keyword/values, category/id, category/name and panvivaDocumentId)
Highlight Tags
 highlightTags string

Accepts highlight pre and post tags in [start-tag,end-tag] template. Example : <em>,</em>. (Note : Default highlight tag is *,*)

Returns

The response from the Panviva API containing enriched search artefact data.

Body
GetEnrichedSearchArtefactResponse

Definitions

ArtefactCategory

A category in the Panviva system, used for classifying artefacts.

Name Path Type Description
id
 id integer

The unique identifier for the artefact category assigned by the system.
categoryName
 categoryName string

The display name of the category used for classifying artefacts.

Category

A category in the Panviva system, used for classifying artefacts.

Name Path Type Description
id
 id integer

The unique identifier for the category.
dateCreated
 dateCreated date-time

The date and time when the category was created.
dateModified
 dateModified date-time

The date and time when the category was last modified.
name
 name string

The display name of the category.

Channel

A list of channels through which this variation can be delivered.

Name Path Type Description
id
 id integer

The unique identifier for the channel.
name
 name string

The name of the channel for content delivery.

Container

A container in the Panviva system, which can hold content, metadata, and links to other resources.

Name Path Type Description
id
 id string

The unique identifier for the container, typically in the format 'document-version-section-subsection'.
name
 name string

The display name or title of the container.
body
 body string

The HTML content of the container, representing the actual content to be displayed.

ContainerRelationship

A relationship between containers, indicating the hierarchy and structure of content within Panviva.

Name Path Type Description
id
 id string

The unique identifier of the container in this relationship.
parent
 parent string

The identifier of the parent container, or null if this is a top-level container.
children
 children array of string
taskFlow
 taskFlow string

The task flow identifier associated with this container relationship, if applicable.

Document

A document in the Panviva system, which can contain content, metadata, and links to other resources.

Name Path Type Description
id
 id string

The unique identifier for the document.
name
 name string

The title or name of the document.
description
 description string

A brief summary describing the document's contents.
version
 version integer

The version number of the document.
language
 language string

The language code for the document (e.g., en-AU for Australian English).
tags
 tags array of Tag
hidden
 hidden boolean

Indicates whether the document is hidden from standard views.
source
 source string

The source or origin of the document.
type
 type string

The type of resource (always 'document' for Document objects).
release
 release integer

The release number of the document.
released
 released boolean

Indicates whether the document has been released/published.
copyright
 copyright string

Copyright information for the document.
classification
 classification string

The document's classification category (e.g., 'films').
status
 status string

The current status of the document (e.g., 'Phase Three').
percentage
 percentage integer

The completion percentage of the document, typically 100 for fully completed documents.
releaseDate
 releaseDate date-time

The date and time when the document was released.
layout
 layout string

The page layout template used for the document (e.g., 'leftTabsMedium').
training
 training Training

Training-related settings and information for this document.
keywords
 keywords array of string

Keywords associated with the document for standard search.
cshKeywords
 cshKeywords array of string

Keywords associated with the document for context-sensitive help (CSH).
updatedDate
 updatedDate date-time

The date and time when the document was last updated.
createdDate
 createdDate date-time

The date and time when the document was created.
reusableContent
 reusableContent boolean

Indicates whether the document contains reusable content blocks.
changeNote
 changeNote string

Notes describing the changes made in the latest version.
links
 links array of Link

EnrichedResponseVariation

A variation of the artefact that can be delivered through different channels.

Name Path Type Description
id
 id integer

The unique identifier for the variation.
dateCreated
 dateCreated date-time

The date and time when the variation was created.
dateModified
 dateModified date-time

The date and time when the variation was last modified.
content
 content array of ResponseSection
simpleContent
 simpleContent string

A simplified version of the content, typically plain text.
channels
 channels array of Channel

EnrichedSearchResult

An enriched search result returned from the Panviva API, containing detailed information about the artefact.

Name Path Type Description
id
 id uuid

The unique identifier for the enriched search result.
content
 content array of ResponseSection
simpleContent
 simpleContent string

A simplified version of the content, typically plain text.
category
 category Category

A category in the Panviva system, used for classifying artefacts.
metaData
 metaData object
searchScore
 searchScore number

The relevance score of the search result, indicating how well it matches the search query.
links
 links array of Link
queryVariations
 queryVariations array of QueryVariation
primaryQuery
 primaryQuery string

The primary search query that was used to retrieve this result.
panvivaDocumentId
 panvivaDocumentId integer

The unique identifier of the Panviva document associated with this result.
panvivaDocumentVersion
 panvivaDocumentVersion integer

The version number of the Panviva document associated with this result.
title
 title string

The title of the enriched search result.
highlights
 highlights Highlights

Highlights of the search result, typically used to indicate matched terms or phrases.

Facet

A facet used for filtering search results based on specific criteria.

Name Path Type Description
field
 field string

The name of the field used for faceting.
groups
 groups array of StringInt64NullableKeyValuePair

Folder

A folder in the Panviva system, used for organizing documents and artefacts.

Name Path Type Description
id
 id string

The unique identifier for the folder.
name
 name string

The display name of the folder.
description
 description string

A brief summary describing the folder's contents.
version
 version integer

The version number of the folder.
language
 language string

The language code for the folder (e.g., en-AU for Australian English).
tags
 tags array of Tag
hidden
 hidden boolean

Indicates whether the folder is hidden from search views.
source
 source string

The source or origin of the folder.
type
 type string

The type of resource (always 'folder' for Folder objects).
links
 links array of Link

GetArtefactCategoriesResponse

The response from the Panviva API containing artefact category data.

Name Path Type Description
categories
 categories array of ArtefactCategory

GetContainerResponse

The response from the Panviva API containing container data.

Name Path Type Description
id
 id string

The unique identifier of the container.
name
 name string

The display name of the container.
body
 body string

The HTML content of the container.

GetDocumentContainerRelationshipsResponse

The response from the Panviva API containing document container relationships.

Name Path Type Description
relationships
 relationships array of ContainerRelationship

GetDocumentContainersResponse

The response from the Panviva API containing document container data.

Name Path Type Description
containers
 containers array of Container

GetDocumentResponse

The response from the Panviva API containing document data.

Name Path Type Description
id
 id string

The unique identifier for the document.
name
 name string

The title or name of the document.
description
 description string

A brief summary describing the document's contents.
version
 version integer

The version number of the document.
language
 language string

The language code for the document (e.g., en-AU for Australian English).
tags
 tags array of Tag
hidden
 hidden boolean

Indicates whether the document is hidden from search.
source
 source string

The source or origin of the document.
type
 type string

The type of resource (always 'document' for Document objects).
release
 release integer

The release number of the document.
released
 released boolean

Indicates whether the document has been released/published.
copyright
 copyright string

Copyright information for the document.
classification
 classification string

The document's classification category (e.g., 'films').
status
 status string

The current status of the document (e.g., 'Phase Three').
percentage
 percentage integer
releaseDate
 releaseDate date-time

The date and time when the document was released.
layout
 layout string

The page layout template used for the document (e.g., 'leftTabsMedium').
training
 training Training

Training-related settings and information for this document.
keywords
 keywords array of string
cshKeywords
 cshKeywords array of string
updatedDate
 updatedDate date-time

The date and time when the document was last updated.
createdDate
 createdDate date-time

The date and time when the document was created.
reusableContent
 reusableContent boolean

Indicates whether the document contains reusable content blocks.
changeNote
 changeNote string

Notes describing the changes made in the latest version.
links
 links array of Link

GetDocumentTranslationsResponse

The response from the Panviva API containing document translation data.

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

The origin of the translation, typically the ID of the original document.

GetEnrichedResponseResponse

The response from the Panviva API containing enriched response data.

Name Path Type Description
links
 links array of Link
title
 title string

The title of the enriched response.
content
 content array of ResponseSection
simpleContent
 simpleContent string

A simplified version of the content, typically plain text.
variations
 variations array of EnrichedResponseVariation
category
 category Category

A category in the Panviva system, used for classifying artefacts.
primaryQuery
 primaryQuery string

The primary search query that was used to retrieve this response.
queryVariations
 queryVariations array of QueryVariation
panvivaDocumentId
 panvivaDocumentId integer

The unique identifier of the Panviva document associated with this response.
panvivaDocumentVersion
 panvivaDocumentVersion integer

The version number of the Panviva document associated with this response.
metaData
 metaData object
id
 id uuid

The unique identifier for the enriched response.
dateCreated
 dateCreated date-time

The date and time when the enriched response was created.
dateModified
 dateModified date-time

The date and time when the enriched response was last modified.

GetEnrichedSearchArtefactResponse

The response from the Panviva API containing enriched search artefact data.

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

The total number of search results found.

GetFileResponse

The response from the Panviva API containing file data.

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

GetFolderChildrenResponse

The response from the Panviva API containing folder children data.

Name Path Type Description
children
 children array of Resource

GetFolderResponse

The response from the Panviva API containing folder data.

Name Path Type Description
id
 id string

The unique identifier for the folder.
name
 name string

The display name of the folder.
description
 description string

A brief summary describing the folder's contents.
version
 version integer

The version number of the folder.
language
 language string

The language code for the folder (e.g., en-AU for Australian English).
tags
 tags array of Tag
hidden
 hidden boolean

Indicates whether the folder is hidden from search views.
source
 source string

The source or origin of the folder.
type
 type string

The type of resource (always 'folder' for Folder objects).
links
 links array of Link

GetFolderRootResponse

The response from the Panviva API containing root folder data.

Name Path Type Description
id
 id string

The unique identifier for the root folder.
name
 name string

The display name of the root folder.
description
 description string

A brief summary describing the root folder's contents.
version
 version integer

The version number of the root folder.
language
 language string

The language code for the root folder (e.g., en-AU for Australian English).
tags
 tags array of Tag
hidden
 hidden boolean

Indicates whether the root folder is hidden from search views.
source
 source string

The source or origin of the root folder.
type
 type string

The type of resource (always 'folder' for Folder objects).
links
 links array of Link

GetFolderTranslationsResponse

The response from the Panviva API containing folder translation data.

Name Path Type Description
translations
 translations array of Folder

GetImageResponse

The response from the Panviva API containing image data.

Name Path Type Description
id
 id string

The unique identifier for the image.
name
 name string

The title or name of the image.
width
 width integer

The width of the image in pixels.
height
 height integer

The height of the image in pixels.
size
 size integer

The size of the image file in bytes.
contentType
 contentType string

The MIME type of the image (e.g., image/jpeg, image/png).
content
 content string

The base64-encoded content of the image.

Highlights

Highlights of the search result, typically used to indicate matched terms or phrases.

Name Path Type Description
primaryQuery
 primaryQuery string

The primary search query that was used to retrieve this result.
title
 title string

The title of the enriched search result.

Hypermedia links related to this resource.

Name Path Type Description
href
 href string

The URL to access the related resource or perform an operation.
rel
 rel string

The relationship type of the link to the current resource (e.g., 'document', 'file').
type
 type string

The HTTP method to use when accessing this link (typically 'GET').

PostArtefactCategoryResponse

The response from the Panviva API after creating a new artefact category.

Name Path Type Description
categoryId
 categoryId integer

The unique identifier of the newly created artefact category.
categoryName
 categoryName string

The display name of the newly created artefact category.

PostArtefactResponse

The response from the Panviva API after creating a new artefact.

Name Path Type Description
hasErrors
 hasErrors boolean

Indicates whether any errors occurred during the artefact creation.
errors
 errors array of string
responseId
 responseId uuid

The unique identifier of the newly created artefact.

PutArtefactResponse

The response from the Panviva API after updating an artefact.

Name Path Type Description
hasErrors
 hasErrors boolean

Indicates whether any errors occurred during the artefact update.
errors
 errors array of string
status
 status string

The status of the artefact update operation.

QueryVariation

Alternative phrasings of queries that should match this artefact.

Name Path Type Description
id
 id integer
query
 query string

The search query text.

Resource

A resource that can be a document, folder, or other types of content.

Name Path Type Description
id
 id string

The unique identifier of the resource.
name
 name string

The display name of the resource.
description
 description string

A brief summary describing the resource's contents.
version
 version integer

The version number of the resource.
language
 language string

The language code for the resource (e.g., en-AU for Australian English).
tags
 tags array of Tag
hidden
 hidden boolean

Indicates whether the resource is hidden from standard views.
source
 source string

The source or origin of the resource.
type
 type string

The type of resource (e.g., 'document', 'folder').

ResponseSection

The content sections of the response.

Name Path Type Description
mediaType
 mediaType string

The media type of the content (e.g., 'text/html', 'text/plain').
text
 text string

The text content of the section.
href
 href string

A hyperlink to additional content or resources.
resourceLocation
 resourceLocation string

The location of the resource, typically a URL or file path.

StringInt64NullableKeyValuePair

A key-value pair where the key is a string and the value is an integer.

Name Path Type Description
key
 key string

The name of the facet group.
value
 value integer

The count of items in this facet group.

Tag

A metadata tag associated with the resource.

Name Path Type Description
name
 name string

The name or key of the tag.
value
 value string

The value associated with the tag.

Training

Training-related settings and information for this document.

Name Path Type Description
failureFeedback
 failureFeedback string

The feedback message displayed when a user fails training for this document.
forcePageSequence
 forcePageSequence boolean

If true, users must view pages in sequence during training.
forceQuestionSequence
 forceQuestionSequence boolean

If true, users must answer questions in sequence during training.
passingScore
 passingScore integer

The minimum score required to pass.
successFeedback
 successFeedback string

The feedback message displayed when a user passes training for this document.

object

This is the type 'object'.