REST Endpoints

SOAP Services

XML Data Elements

XML Data Types

XlsIngestService

Web service used to manage xls ingestion.

Endpoint Metadata

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

The following methods are available on this endpoint:

findAllParserConfigs

Finds all active xls parser configurations

Return Value

type description
list<XlsParserConfig> list of xls parser configurations

Faults

name description
XlsIngestWebServiceFault error

findParserConfigByPK

Finds xls parser config by primary key.

Input Parameters

name type description
parserConfigPk integer primary key of xls config

Return Value

type description
XlsParserConfig xls parser config

Faults

name description
XlsIngestWebServiceFault if configuration could not be found

findParserConfigByUuid

Finds xls parser config by UUID.

Input Parameters

name type description
parserConfigUuid string uuid of xls parser

Return Value

type description
XlsParserConfig xls parser config

Faults

name description
XlsIngestWebServiceFault if configuration could not be found

ingestSpreadsheet

This method has been deprecated. have to useXlsIngestWebServiceLocal#ingestSpreadsheetWithRestrictionKey(SoapFile, Integer, Integer, String, String, String)

Initiate ingest of a spreadsheet file.

Input Parameters

name type description
file soapFile xls file
parserConfigPk integer An identifier of parser configuration that will be used to ingest xls files
localePk integer locale which will be used for data ingestion
processId string Process identifier of an asynchronous ESB service. If not provided, no attempt will be made to notify ESB service of success or failure.
workflowUUID string UUID of the workflow

Faults

name description
XlsIngestWebServiceFault error

ingestSpreadsheetWithRestrictionKey

Initiate ingest of a spreadsheet file.

Input Parameters

name type description
file soapFile xls file
parserConfigPk integer An identifier of parser configuration that will be used to ingest xls files
localePk integer locale which will be used for data ingestion
processId string Process identifier of an asynchronous ESB service. If not provided, no attempt will be made to notify ESB service of success or failure.
workflowUUID string UUID of the workflow
restrictionKey string restriction key

Faults

name description
XlsIngestWebServiceFault error