REST Endpoints

SOAP Services

XML Data Elements

XML Data Types

AugmentationService

This class represents augmentation web service.

Endpoint Metadata

  • Namespace: http://opencase.extend.com/webservices/augmentation
  • Endpoint Name: AugmentationWebService
  • Endpoint Address: http(s)://{VMS URL}/ContentManager/webservices/augmentation-service

The following methods are available on this endpoint:

augmentMetadata

Puts request to augment metadata of the given bundles for AugmentationJob

Input Parameters

name type description
values list<NameValuePair> The list of NameValuePair that is required to process an augmentation request

The required NameValuePair:

  • BUNDLE_PKS - The list of bundle IDs
  • PROCESS_ID - The process ID of the workflow that triggered the augmentation event
  • PLUGIN_PK - The primary key of metadata source provider plug-in

Faults

name description
AugmentationParameterFault if either bundleIds or workflowId is not provided
AugmentationWebserviceFault if augmentation process has failed

findActiveMetadataSourceProviders

Finds all active metadata source provider plug-ins

Return Value

type description
list<augmentationMetadataSourcePlugin> The list of active metadata source provider plug-ins

Faults

name description
AugmentationWebserviceFault if unexpected error occurs while retrieving metadata source provider plug-ins