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.
Status: Preview |
Tier: Premium |
Version: 1.0 |
Name |
Summary |
Search |
|
Search Artefacts |
|
OperationsLiveCsh (string instance, [Optional]PostLiveCshRequest postLiveCshRequest) |
Live CSH |
OperationsLiveDocument (string instance, [Optional]PostLiveDocumentRequest postLiveDocumentRequest) |
Live Document |
OperationsLiveSearch (string instance, [Optional]PostLiveSearchRequest postLiveSearchRequest) |
Live Search |
Container |
|
ResourcesDocumentById (string instance, string id, [advanced][Optional]integer version) |
Document |
Artefact |
|
ResourcesDocumentByIdContainers (string instance, integer id) |
Document Containers |
ResourcesDocumentByIdContainersRelationships (string instance, integer id) |
Document Container Relationships |
ResourcesDocumentByIdTranslations (string instance, integer id) |
Document Translations |
File |
|
Folder |
|
Folder Children |
|
ResourcesFolderByIdTranslations (string instance, integer id) |
Folder Translations |
Folder Root |
|
Image |
|
Get Artefact Categories |
|
Create Artefact Category |
Name |
Summary |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Search
Description: Searches documents, folders, and files (external documents) for a term and returns paginated results
Syntax:
Panviva.OperationsSearch (string instance, string term, [advanced][Optional]integer pageOffset, [advanced][Optional]integer pageLimit)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
instance |
string (Instance) |
The instance name as shown on the Panviva Developer Portal. |
True |
|
term |
string (Term) |
The word or phrase to be searched for |
True |
|
pageOffset |
integer (Page Offset) |
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. |
False |
|
pageLimit |
integer (Page Limit) |
The number of records to return. Must be an integer between 0 and 1000. |
False |
Returns:
Type:GetSearchResponse
Summary: Search Artefacts
Description: Return search results for a given query
Syntax:
Panviva.OperationsArtefactNls (string instance, [Optional]string simplequery, [advanced][Optional]string advancedquery, [advanced][Optional]string filter, [Optional]string channel, [advanced][Optional]integer pageOffset, [advanced][Optional]integer pageLimit, [advanced][Optional]string facet)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
instance |
string (Instance) |
The instance name as shown on the Panviva Developer Portal. |
True |
|
simplequery |
string (Simple Query) |
Natural language query string. For example: 'Action Movies'. (Note: Use simplequery OR advancedquery, not both.) |
False |
|
advancedquery |
string (Advanced Query) |
Query string written in Lucene query syntax. For example: 'films AND "a story"'. (Note: Use simplequery OR advancedquery, not both.) |
False |
|
filter |
string (Filter) |
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) |
False |
|
channel |
string (Channel) |
Return response for a specific channel, instead of the default |
False |
|
pageOffset |
integer (Page Offset) |
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. |
False |
|
pageLimit |
integer (Page Limit) |
The number of records to return. Must be an integer between 0 and 1000. |
False |
|
facet |
string (Facet) |
Accepts a Lucene-formatted facet string. Examples: 'facet=Category,count:10&facet=Rating'. (Facetable fields include metaData/values) |
False |
Returns:
Type:GetSearchArtefactResponse
Summary: Live CSH
Description: Present a CSH search result page of the passing query on Panviva client to specified user on Panviva client
Syntax:
Panviva.OperationsLiveCsh (string instance, [Optional]PostLiveCshRequest postLiveCshRequest)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
instance |
string (Instance) |
The instance name as shown on the Panviva Developer Portal. |
True |
|
postLiveCshRequest |
|
|
False |
Returns:
Type:PostLiveCshResponse
Summary: Live Document
Description: Present a document page to specified user on Panviva client
Syntax:
Panviva.OperationsLiveDocument (string instance, [Optional]PostLiveDocumentRequest postLiveDocumentRequest)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
instance |
string (Instance) |
The instance name as shown on the Panviva Developer Portal. |
True |
|
postLiveDocumentRequest |
|
|
False |
Returns:
Summary: Live Search
Description: Present a search result page of the passing query on Panviva client to specified user on Panviva client
Syntax:
Panviva.OperationsLiveSearch (string instance, [Optional]PostLiveSearchRequest postLiveSearchRequest)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
instance |
string (Instance) |
The instance name as shown on the Panviva Developer Portal. |
True |
|
postLiveSearchRequest |
|
|
False |
Returns:
Summary: Container
Description: Return a container using the container ID provided
Syntax:
Panviva.ResourcesContainerById (string instance, string id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
instance |
string (Instance) |
The instance name as shown on the Panviva Developer Portal. |
True |
|
id |
string (Id) |
The id of a document container |
True |
Returns:
Type:GetContainerResponse
Summary: Document
Description: Return a document using the document ID provided
Syntax:
Panviva.ResourcesDocumentById (string instance, string id, [advanced][Optional]integer version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
instance |
string (Instance) |
The instance name as shown on the Panviva Developer Portal. |
True |
|
id |
string (Id) |
A document unique identifier, Document ID. If a document is a translated document, this value represents Internal ID or IID in Panviva API v1. |
True |
|
version |
integer (Version) |
Request the API to return a particular version of the specified document. |
False |
Returns:
Type:GetDocumentResponse
Summary: Artefact
Description: Return an artefact using the ID provided
Syntax:
Panviva.ResourcesArtefactById (string instance, string id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
instance |
string (Instance) |
The instance name as shown on the Panviva Developer Portal. |
True |
|
id |
string (Id) |
Format - uuid. The id (ID) of an artefact |
True |
Returns:
Type:GetResponseResponse
Summary: Document Containers
Description: Return a list of containers using the document ID provided
Syntax:
Panviva.ResourcesDocumentByIdContainers (string instance, integer id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
instance |
string (Instance) |
The instance name as shown on the Panviva Developer Portal. |
True |
|
id |
integer (Id) |
The internal id (IID) of a Panviva document |
True |
Returns:
Type:GetDocumentContainersResponse
Summary: Document Container Relationships
Description: Return a list of the parent-child relationship between each container for the document ID provided
Syntax:
Panviva.ResourcesDocumentByIdContainersRelationships (string instance, integer id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
instance |
string (Instance) |
The instance name as shown on the Panviva Developer Portal. |
True |
|
id |
integer (Id) |
The internal id (IID) of a Panviva document |
True |
Returns:
Type:GetDocumentContainerRelationshipsResponse
Summary: Document Translations
Description: Return a list of all translations (per language and locale) of a Panviva document
Syntax:
Panviva.ResourcesDocumentByIdTranslations (string instance, integer id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
instance |
string (Instance) |
The instance name as shown on the Panviva Developer Portal. |
True |
|
id |
integer (Id) |
The internal id (IID) of a Panviva document. |
True |
Returns:
Type:GetDocumentTranslationsResponse
Summary: File
Description: Returns a file (external document) from Panviva
Syntax:
Panviva.ResourcesFileById (string instance, integer id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
instance |
string (Instance) |
The instance name as shown on the Panviva Developer Portal. |
True |
|
id |
integer (Id) |
The internal id (IID) of a Panviva file (external document) |
True |
Returns:
Type:GetFileResponse
Summary: Folder
Description: Return information about a Panviva folder and references to each of its direct children
Syntax:
Panviva.ResourcesFolderById (string instance, integer id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
instance |
string (Instance) |
The instance name as shown on the Panviva Developer Portal. |
True |
|
id |
integer (Id) |
The internal id (IID) of a Panviva folder |
True |
Returns:
Type:GetFolderResponse
Summary: Folder Children
Description: Gets all the immediate children of a Panviva folder, not including grandchildren. Children can be folders, documents, or files (external documents)
Syntax:
Panviva.ResourcesFolderByIdChildren (string instance, integer id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
instance |
string (Instance) |
The instance name as shown on the Panviva Developer Portal. |
True |
|
id |
integer (Id) |
The internal id (IID) of a Panviva folder |
True |
Returns:
Type:GetFolderChildrenResponse
Summary: Folder Translations
Description: Gets all the translations of a Panviva folder, along with each translated folders respective children
Syntax:
Panviva.ResourcesFolderByIdTranslations (string instance, integer id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
instance |
string (Instance) |
The instance name as shown on the Panviva Developer Portal. |
True |
|
id |
integer (Id) |
The internal id (IID) of a Panviva folder |
True |
Returns:
Type:GetFolderTranslationsResponse
Summary: Folder Root
Description: 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
Syntax:
Panviva.ResourcesFolderRoot (string instance)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
instance |
string (Instance) |
The instance name as shown on the Panviva Developer Portal. |
True |
Returns:
Summary: Image
Description: Returns an image from Panviva. Image data is represented as a base64 string
Syntax:
Panviva.ResourcesImageById (string instance, integer id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
instance |
string (Instance) |
The instance name as shown on the Panviva Developer Portal. |
True |
|
id |
integer (Id) |
The id of a Panviva image |
True |
Returns:
Type:GetImageResponse
Summary: Get Artefact Categories
Description: Gets a list of all available artefact categories
Syntax:
Panviva.ResourcesArtefactCategoriesGet (string instance)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
instance |
string (Instance) |
The instance name as shown on the Panviva Developer Portal. |
True |
Returns:
Type:GetArtefactCategoriesResponse
Summary: Create Artefact Category
Description: Creates a category for classifying artefacts
Syntax:
Panviva.ResourcesArtefactCategoryPost (string instance, [Optional]PostArtefactCategoryRequest postArtefactCategoryRequest)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
instance |
string (Instance) |
The instance name as shown on the Panviva Developer Portal. |
True |
|
postArtefactCategoryRequest |
|
|
False |
Returns:
Type:PostArtefactCategoryResponse
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer
|
|
categoryName |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string
|
|
id |
integer
|
|
dateCreated |
string(date-time)
|
|
dateModified |
string(date-time)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
name |
string
|
|
body |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
parent |
string
|
|
children |
array of (string)
|
|
taskFlow |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
name |
string
|
|
description |
string
|
|
version |
integer
|
|
language |
string
|
|
tags |
array of (Tag)
|
|
hidden |
boolean
|
|
source |
string
|
|
type |
string
|
|
release |
integer
|
|
released |
boolean
|
|
copyright |
string
|
|
classification |
string
|
|
status |
string
|
|
percentage |
integer
|
|
releaseDate |
string(date-time)
|
|
layout |
string
|
|
training |
|
|
keywords |
array of (string)
|
|
cshKeywords |
array of (string)
|
|
updatedDate |
string(date-time)
|
|
createdDate |
string(date-time)
|
|
reusableContent |
boolean
|
|
changeNote |
string
|
|
links |
array of (Link)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
field |
string
|
|
groups |
array of (StringInt64NullableKeyValuePair)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
name |
string
|
|
description |
string
|
|
version |
integer
|
|
language |
string
|
|
tags |
array of (Tag)
|
|
hidden |
boolean
|
|
source |
string
|
|
type |
string
|
|
links |
array of (Link)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
categories |
array of (ArtefactCategory)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
name |
string
|
|
body |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
relationships |
array of (ContainerRelationship)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
containers |
array of (Container)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
name |
string
|
|
description |
string
|
|
version |
integer
|
|
language |
string
|
|
tags |
array of (Tag)
|
|
hidden |
boolean
|
|
source |
string
|
|
type |
string
|
|
release |
integer
|
|
released |
boolean
|
|
copyright |
string
|
|
classification |
string
|
|
status |
string
|
|
percentage |
integer
|
|
releaseDate |
string(date-time)
|
|
layout |
string
|
|
training |
|
|
keywords |
array of (string)
|
|
cshKeywords |
array of (string)
|
|
updatedDate |
string(date-time)
|
|
createdDate |
string(date-time)
|
|
reusableContent |
boolean
|
|
changeNote |
string
|
|
links |
array of (Link)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
translations |
array of (Document)
|
|
origin |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
name |
string
|
|
description |
string
|
|
version |
integer
|
|
language |
string
|
|
tags |
array of (Tag)
|
|
hidden |
boolean
|
|
source |
string
|
|
type |
string
|
|
content |
string
|
|
fileName |
string
|
|
release |
integer
|
|
released |
boolean
|
|
copyright |
string
|
|
classification |
string
|
|
status |
string
|
|
percentage |
integer
|
|
releaseDate |
string(date-time)
|
|
keywords |
array of (string)
|
|
cshKeywords |
array of (string)
|
|
changeNote |
string
|
|
updatedDate |
string(date-time)
|
|
createdDate |
string(date-time)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
children |
array of (Resource)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
name |
string
|
|
description |
string
|
|
version |
integer
|
|
language |
string
|
|
tags |
array of (Tag)
|
|
hidden |
boolean
|
|
source |
string
|
|
type |
string
|
|
links |
array of (Link)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
name |
string
|
|
description |
string
|
|
version |
integer
|
|
language |
string
|
|
tags |
array of (Tag)
|
|
hidden |
boolean
|
|
source |
string
|
|
type |
string
|
|
links |
array of (Link)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
translations |
array of (Folder)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
name |
string
|
|
width |
integer
|
|
height |
integer
|
|
size |
integer
|
|
contentType |
string
|
|
content |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
links |
array of (Link)
|
|
title |
string
|
|
content |
array of (ResponseSection)
|
|
variations |
array of (ResponseVariation)
|
|
category |
|
|
primaryQuery |
string
|
|
queryVariations |
array of (QueryVariation)
|
|
panvivaDocumentId |
integer
|
|
panvivaDocumentVersion |
integer
|
|
metaData |
|
|
id |
string(uuid)
|
|
dateCreated |
string(date-time)
|
|
dateModified |
string(date-time)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
facets |
array of (Facet)
|
|
results |
array of (SearchResult)
|
|
total |
integer
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
results |
array of (ResourceSearchResult)
|
|
total |
integer
|
|
links |
array of (Link)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
href |
string
|
|
rel |
string
|
|
type |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
categoryId |
integer
|
|
categoryName |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
username |
string
|
The Panviva user to whom you wish to send the result. (Note: Use username OR userId, not both.) |
userId |
string
|
The numeric ID of the user to whom you wish to send the result. (Note: Use username OR userId, not both.) |
query |
string
|
The CSH term to search for. |
showFirstResult |
boolean
|
True to immediately open the first document found, or false to show the list of results. |
maximizeClient |
boolean
|
True/False depending on whether you want the Panviva client to maximize on the user's desktop, when the document is delivered. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
username |
string
|
The Panviva user to whom you wish to send the result. (Note: Use username OR userId, not both.) |
userId |
string
|
The numeric ID of the user to whom you wish to send the result. (Note: Use username OR userId, not both.) |
id |
string
|
The Document ID of the Panviva Document you wish to send. |
location |
string
|
The Section ID you would like the user to see, when the specified document is opened. |
maximizeClient |
boolean
|
True/False depending on whether you want the Panviva client to maximize on the user's desktop, when the document is delivered. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
username |
string
|
The Panviva user to whom you wish to send the result. (Note: Use username OR userId, not both.) |
userId |
string
|
The numeric ID of the user to whom you wish to send the result. (Note: Use username OR userId, not both.) |
query |
string
|
The term to search for. |
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 |
boolean
|
True to immediately open the first document found, or false to show the list of results. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer
|
|
query |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
name |
string
|
|
description |
string
|
|
version |
integer
|
|
language |
string
|
|
tags |
array of (Tag)
|
|
hidden |
boolean
|
|
source |
string
|
|
type |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
type |
string
|
|
id |
string
|
|
name |
string
|
|
description |
string
|
|
matchedFields |
array of (string)
|
|
snippet |
string
|
|
language |
string
|
|
links |
array of (Link)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
mediaType |
string
|
|
text |
string
|
|
href |
string
|
|
resourceLocation |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
content |
array of (ResponseSection)
|
|
channels |
array of (Channel)
|
|
id |
integer
|
|
dateCreated |
string(date-time)
|
|
dateModified |
string(date-time)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string(uuid)
|
|
content |
array of (ResponseSection)
|
|
category |
|
|
metaData |
|
|
searchScore |
number
|
|
links |
array of (Link)
|
|
queryVariations |
array of (QueryVariation)
|
|
primaryQuery |
string
|
|
panvivaDocumentId |
integer
|
|
panvivaDocumentVersion |
integer
|
|
title |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
key |
string
|
|
value |
integer(int64)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string
|
|
value |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
failureFeedback |
string
|
|
forcePageSequence |
boolean
|
|
forceQuestionSequence |
boolean
|
|
passingScore |
integer
|
|
successFeedback |
string
|
|