public interface ExternalJobSchedulerIntegrationService
This service enables external job schedulers to connect to the SAP back-end and perform the following operations on application jobs: get a list of application job templates, instantiate a job from a job template without parameters and with start condition ‘immediate start’, read the status of a job, and cancel or deschedule a job.
Reference: SAP API Business Hub
OData Service: | BC_EXT_APPJOB_MANAGEMENT |
API Version: | 2 |
Communication Scenario: | External Scheduler Integration (SAP_COM_0064) |
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_SERVICE_PATH
If no other path was provided via the
withServicePath(String) method, this is the default service path used to access the endpoint. |
Modifier and Type | Method and Description |
---|---|
JobTemplateFluentHelper |
getAllJobTemplate()
Fetch multiple
JobTemplate entities. |
JobTemplateByKeyFluentHelper |
getJobTemplateByKey(String jobTemplateName,
String jobTemplateVersion)
Fetch a single
JobTemplate entity using key fields. |
JobAbortFluentHelper |
jobAbort(String jobRunCount,
String jobName)
Creates a fluent helper for the JobAbort OData function import.
|
JobCancelFluentHelper |
jobCancel(String jobRunCount,
String jobName)
Creates a fluent helper for the JobCancel OData function import.
|
JobScheduleFluentHelper |
jobSchedule(String jobUserID,
String jobUserName,
String jobText,
String jobTemplateName,
String jobParameterValues,
Boolean testModeInd,
String jobUser)
Creates a fluent helper for the JobSchedule OData function import.
|
JobStatusGetFluentHelper |
jobStatusGet(String jobName,
String jobRunCount)
Creates a fluent helper for the JobStatusGet OData function import.
|
ExternalJobSchedulerIntegrationService |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path used to access the endpoint.ExternalJobSchedulerIntegrationService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull JobTemplateFluentHelper getAllJobTemplate()
JobTemplate
entities.JobTemplate
entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute
method on the fluent helper object.@Nonnull JobTemplateByKeyFluentHelper getJobTemplateByKey(String jobTemplateName, String jobTemplateVersion)
JobTemplate
entity using key fields.jobTemplateName
- jobTemplateVersion
- JobTemplate
entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute
method on the fluent helper object.@Nonnull JobScheduleFluentHelper jobSchedule(String jobUserID, String jobUserName, String jobText, String jobTemplateName, String jobParameterValues, Boolean testModeInd, String jobUser)
Creates a fluent helper for the JobSchedule OData function import.
testModeInd
- IndicatorConstraints: Nullable
Original parameter name from the Odata EDM: TestModeInd
jobText
- Constraints: Not nullable, Maximum length: 120Original parameter name from the Odata EDM: JobText
jobUserName
- Constraints: Nullable, Maximum length: 12Original parameter name from the Odata EDM: JobUserName
jobParameterValues
- Constraints: NullableOriginal parameter name from the Odata EDM: JobParameterValues
jobUser
- Constraints: Nullable, Maximum length: 40Original parameter name from the Odata EDM: JobUser
jobUserID
- Constraints: Nullable, Maximum length: 40Original parameter name from the Odata EDM: JobUserID
jobTemplateName
- Constraints: Not nullable, Maximum length: 40Original parameter name from the Odata EDM: JobTemplateName
execute
method on the fluent helper object.@Nonnull JobCancelFluentHelper jobCancel(String jobRunCount, String jobName)
Creates a fluent helper for the JobCancel OData function import.
jobName
- Constraints: Not nullable, Maximum length: 32Original parameter name from the Odata EDM: JobName
jobRunCount
- Constraints: Not nullable, Maximum length: 14Original parameter name from the Odata EDM: JobRunCount
execute
method on the fluent helper object.@Nonnull JobAbortFluentHelper jobAbort(String jobRunCount, String jobName)
Creates a fluent helper for the JobAbort OData function import.
jobName
- Constraints: Not nullable, Maximum length: 32Original parameter name from the Odata EDM: JobName
jobRunCount
- Constraints: Not nullable, Maximum length: 14Original parameter name from the Odata EDM: JobRunCount
execute
method on the fluent helper object.@Nonnull JobStatusGetFluentHelper jobStatusGet(String jobName, String jobRunCount)
Creates a fluent helper for the JobStatusGet OData function import.
jobName
- Constraints: noneOriginal parameter name from the Odata EDM: JobName
jobRunCount
- Constraints: noneOriginal parameter name from the Odata EDM: JobRunCount
execute
method on the fluent helper object.Copyright © 2018 SAP SE. All rights reserved.