API Documentation
Refer to https://uperformhelp.ancile.com/hc/en-us/articles/360041395291-Managing-API-Access-Keys for summary information and steps to create an API Key.
Request Authorization
All API requests are authorized by an API Key which must be provided in an authorization header whose value is: Ancile-Api-Key APIKeyValue
Where APIKeyValue is obtained when you create an API key in the system.
uPerform APIs
There are two APIs available for external use and are described below. All API responses are in json format.
uPerform Content Search API: Content Search
Performs a full text search of indexed content in the system. This API provides same search behavior as a user doing a manual search using the Search field in the Learning Library user interface.
API format: https://LearningLibraryFQDN/api/distribution/v1/search?query=searchterm
|
URL item |
Description |
|
LearningLibraryFQDN |
The fully qualified domain name of your Learning Library instance. For example, if your Learning Library URL is https://acme.ancileuperform.com/#/, you would use acme.ancileuperform.com |
|
searchterm |
The term to be searched |
Optional Query String Parameters
|
Parameter |
Description |
Notes |
|
limit |
Defines the maximum number of items to be returned in initial response |
If undefined, default is 25 |
|
offset |
The number of items skipped before returning records in the response |
If undefined, default is 0 |
|
type |
ManagedDocument, Document, Course |
If undefined, all types are returned |
Response Attributes
|
Attribute |
Description |
Notes |
|
offset |
The number of items skipped before returning records in the response. Response is simply repeating the offset value sent in the request |
|
|
limit |
Defines the maximum number of items to be returned. Response is repeating the limit value sent in the request |
|
|
total |
Total number of items available |
|
|
first/prev/next/last |
When the total – limit is greater than zero (e.g. pagination of results is necessary), the response will include necessary request URLs to support pagination of the results |
|
|
items |
Array of items returned by the search |
|
|
The following attributes exist for each item in the Items array. |
||
|
name |
The name of the item |
Value always included in the response |
|
description |
The description of the item |
Value included if defined in the system |
|
type |
The document type |
Value always included in the response |
|
libraryUrl |
URL used to display the item in the Learning Library site |
Value always included in the response |
uPerform Content Search API: Context-Sensitive Help Search
Performs a search of content based on special properties in documents. These properties typically are populated automatically during recording. This API provides same search behavior as the in-application help functionality provided by the system.
API format: https://LearningLibraryFQDN/api/distribution/v1/CshSearch/ConnectionProfileOID?csh=searchterm
|
URL item |
Description |
|
LearningLibraryFQDN |
The fully qualified domain name of your Learning Library instance. For example, if your Learning Library URL is https://acme.ancileuperform.com/#/, you would use acme.ancileuperform.com |
|
ConnectionProfileOID |
The identifier of the connection profile the search will use. The identifier is system defined when you create a connection profile in the system. Refer to https://uperformhelp.ancile.com/hc/en-us/articles/360000747071-Managing-Connection-Profiles-to-the-Server for how to create a connection profile. For use with the CshSearch endpoint, create a profile of Connector = web, Application = custom integration, and Search Method = transaction code. The identifier can be extracted from the URL generated when you create the connection profile. It is of the form 1.11. Example: https://sdig-preview.ancileuperform.com/#/csh/1.11.4701?csh= |
|
searchterm |
The term to be searched |
Optional Query String Parameters
|
Parameter |
Description |
Notes |
|
limit |
Defines the maximum number of items to be returned in initial response |
If undefined, default is 25 |
|
offset |
The number of items skipped before returning records in the response |
If undefined, default is 0 |
Response Attributes
|
Attribute |
Description |
Notes |
|
offset |
The number of items skipped before returning records in the response. Response is simply repeating the offset value sent in the request |
|
|
limit |
Defines the maximum number of items to be returned. Response is repeating the limit value sent in the request |
|
|
total |
Total number of items available |
|
|
first/prev/next/last |
When the total – limit is greater than zero (e.g. pagination of results is necessary), the response will include necessary request URLs to support pagination of the results |
|
|
items |
Array of items returned by the search |
|
|
The following attributes exist for each item in the Items array. |
||
|
name |
The name of the item |
Value always included in the response |
|
description |
The description of the item |
Value included if defined in the system |
|
type |
The document type |
Value always included in the response |
|
libraryUrl |
URL used to display the item in the Learning Library site |
Value always included in the response |