![]() |
Openscape Voice V10 - SOAP Interface Documentation
|
Background Job Definitions and Methods. More...
Classes | |
| struct | unsp__JobResultEntry |
| Job Result Entry. More... | |
| struct | unsp__JobResultList |
| Job Result List. More... | |
| struct | unsp__GetJobInfoResult |
| Get Job Information result. More... | |
| struct | unsp__GetJobListOptionEntry |
| Get Job Option Entry. More... | |
| struct | unsp__GetJobListOptionList |
| Get Job Option List. More... | |
| struct | unsp__GetJobListOptions |
| Get Job List Options. More... | |
| struct | unsp__GetJobListEntry |
| Get Job List Entry. More... | |
| struct | unsp__GetJobListData |
| Get Job List data. More... | |
| struct | unsp__GetJobListResult |
| Get Job Information result. More... | |
| struct | unsp__GetJobInfoRequest |
| Get Job Information request. More... | |
| struct | unsp__GetJobListByOptionRequest |
| get Job Information by Option request. More... | |
| struct | unsp__CancelJobRequest |
| Cancel Job request. More... | |
| struct | unsp__CancelJobResult |
| Cancel Job result. More... | |
| struct | unsp__GenericJobRequest |
| Generic Job request. More... | |
| struct | unsp__GenericJobResult |
| Generic Job result. More... | |
Enumerations | |
| enum | unsp__ObjectType { BG, DN, FP, QP, LOG, GENERIC, EZIP, DBS } |
| The type of object for which this job has been submitted. More... | |
| enum | unsp__JobStatus { Waiting, InProgress, Complete, Canceled, Partial, Error } |
| The status of a job. More... | |
| enum | unsp__JobAction { AddFeature, RemoveFeature, UpdateFeature, RemoveCaleaEntry, UpdateMlhgMemberCaleaEntry, RemoveMlhgMemberCaleaEntry, UpdateBGDefaultQOSProfile, UpdateQOSProfile, AuditFeatureProfile, CollectLogFiles, GenericAuditHomeDn, AccessEZIPParm, DeleteBGSuite } |
| The action to be performed by a job. More... | |
| enum | unsp__GetJobListOption { FilterByBgName, FilterByOperatorId, FilterByFpName } |
| Specifies filter types in order to retrieve the list of desired jobs. More... | |
Functions | |
| int | unsp__GetJobInfo2 (struct unsp__GetJobInfoRequest GetJobInfoRequest, struct unsp__GetJobInfoResult *JobInfoResult) |
| This method retrieves information for a particular job. More... | |
| int | unsp__GetJobListByOption2 (struct unsp__GetJobListByOptionRequest GetJobListByOptionRequest, struct unsp__GetJobListResult *GetJobListResult) |
| This method retrieves the list of Jobs based on filtering options. More... | |
| int | unsp__CancelJob2 (struct unsp__CancelJobRequest CancelJobRequest, struct unsp__CancelJobResult *CancelJobResult) |
| This method terminates the processing of the specified currently running or waiting job. More... | |
| int | unsp__GenericJob (struct unsp__GenericJobRequest GenericJobRequest, struct unsp__GenericJobResult *GenericJobResult) |
| This method supports submission of generic jobs. More... | |
Background Job Definitions and Methods.
The OpenScape Voice system supports background jobs in specific situations. Jobs are used for SOAP requests that require more processing time than a client will typically wait for. There are several types of requests that require more time than available; the most common involves updates to Feature Profiles, which may require the updating of several thousand subscribers. Upon receipt of this type of request, the OpenScape Voice system returns the JobId tag in the ResultCodeStruct. When this field is returned, it means that the request has been successfully received, validated, and applied to the Feature Profile and updates have been scheduled for the affected subscribers. The status of the job may be obtained using the GetJobInfo method and a list of existing jobs may be obtained using the GetJobList method. The CancelJob method may be used to terminate a running or waiting job.
| enum unsp__JobAction |
The action to be performed by a job.
| enum unsp__JobStatus |
| enum unsp__ObjectType |
| unsp__CancelJob2 | ( | struct unsp__CancelJobRequest | CancelJobRequest, |
| struct unsp__CancelJobResult * | CancelJobResult | ||
| ) |
This method terminates the processing of the specified currently running or waiting job.
| CancelJobRequest | API request |
| CancelJobResult | API result |
| unsp__GenericJob | ( | struct unsp__GenericJobRequest | GenericJobRequest, |
| struct unsp__GenericJobResult * | GenericJobResult | ||
| ) |
This method supports submission of generic jobs.
| GenericJobRequest | API request |
| GenericJobResult | API result |
| unsp__GetJobInfo2 | ( | struct unsp__GetJobInfoRequest | GetJobInfoRequest, |
| struct unsp__GetJobInfoResult * | JobInfoResult | ||
| ) |
This method retrieves information for a particular job.
| GetJobInfoRequest | API request |
| JobInfoResult | API result |
| unsp__GetJobListByOption2 | ( | struct unsp__GetJobListByOptionRequest | GetJobListByOptionRequest, |
| struct unsp__GetJobListResult * | GetJobListResult | ||
| ) |
This method retrieves the list of Jobs based on filtering options.
| GetJobListByOptionRequest | API request |
| GetJobListResult | API result |
1.8.6