IngestService
Endpoint Metadata
- Namespace: http://videoscape.cisco.com/epg/webservices/ingest
- Endpoint Name: IngestWebService
- Endpoint Address: http(s)://{VMS URL}/LinearManager/webservices/ingest-service
The following methods are available on this endpoint:
Finalize the ingest process. Since the ingest process can consist of 1 to N long running steps, it is not possible to guess when theprocess is completed. This interface provides the ability to let LinearManager know that ingest of EPG data has completed and that stepsshould be taken to finalize the process and expose the newly imported data to the public. The following steps are part of the FinalizeIngest process:
- Get Content Manager Extended Station Information
- Finalize Program and Schedule ingest
- Publish
- Flush All Caches
- Fail On Error
- Finish EPG Workflow
The call is asynchronous and returns immediately.
Input Parameters
name |
type |
description |
step |
string |
Ingest step to execute. For valid list of steps see com.cisco.videoscape.lm.common.IngestStep |
processId |
string |
Process id 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 |
IngestWebServiceFault |
(no documentation provided) |
Initiate ingest of a feed file.
Input Parameters
name |
type |
description |
repositoryPaths |
list |
Repository paths to files which should be ingested. Single entry in the list is used to query the repository manager for location of the feed file. The file can reside on a remote server that can be an FTP server or a web server and might require credentials to log in. |
fragmentType |
string |
An identifier for the type of fragment this file represents. Valid values for default parsers are defined in com.cisco.videoscape.lm.common.FragmentType If fragmentType is not set, will assume fragment type is single. If using a custom parser, can submit custom types that the parser will understand. |
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 |
IngestWebServiceFault |
(no documentation provided) |
Initiate ingest of a local feed file.
Input Parameters
name |
type |
description |
localFilePaths |
list |
Paths to files which should be ingested. The file resides on a local file system. |
fragmentType |
string |
An identifier for the type of fragment this file represents. Valid values for default parsers are defined in com.cisco.videoscape.lm.common.FragmentType If fragmentType is not set, will assume single. If using a custom parser, can submit custom types that the parser will understand. |
processId |
string |
Process id 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 |
IngestWebServiceFault |
(no documentation provided) |