Package | Description |
---|---|
com.sap.cloud.sdk.services.rest.apiclient | |
com.sap.cloud.sdk.services.scp.workflow.cf.api |
Modifier and Type | Method and Description |
---|---|
<T> T |
ApiClient.invokeAPI(String path,
org.springframework.http.HttpMethod method,
org.springframework.util.MultiValueMap<String,String> queryParams,
Object body,
org.springframework.http.HttpHeaders headerParams,
org.springframework.util.MultiValueMap<String,Object> formParams,
List<org.springframework.http.MediaType> accept,
org.springframework.http.MediaType contentType,
String[] authNames,
org.springframework.core.ParameterizedTypeReference<T> returnType)
Invoke API by sending HTTP request with the given options.
|
Modifier and Type | Method and Description |
---|---|
SampleContext |
WorkflowDefinitionsApi.getDefaultSampleContext(String definitionId)
Retrieve sample start context of workflow definition by ID
|
SampleContext |
WorkflowDefinitionsApi.getDefaultSampleContextForVersion(String definitionId,
String versionNumber)
Retrieve sample start context of workflow definition by ID and version number
|
WorkflowDefinition |
WorkflowDefinitionsApi.getDefinition(String definitionId)
Retrieve workflow definition by ID
|
WorkflowDefinition |
WorkflowDefinitionsApi.getDefinition(String definitionId,
String acceptLanguage)
Retrieve workflow definition by ID
|
WorkflowDefinitionVersion |
WorkflowDefinitionsApi.getDefinitionVersion(String definitionId,
String versionNumber)
Retrieve workflow definition by ID and version number
|
WorkflowDefinitionVersion |
WorkflowDefinitionsApi.getDefinitionVersion(String definitionId,
String versionNumber,
String acceptLanguage)
Retrieve workflow definition by ID and version number
|
List<WorkflowDefinitionVersion> |
WorkflowDefinitionsApi.getDefinitionVersions(String definitionId)
Retrieve all versions of workflow definition by ID
|
List<WorkflowDefinitionVersion> |
WorkflowDefinitionsApi.getDefinitionVersions(String definitionId,
String acceptLanguage,
String $orderby,
Integer $skip,
Integer $top,
String $inlinecount)
Retrieve all versions of workflow definition by ID
|
List<FormMetadata> |
FormsApi.getFormDefinitionsMetadata()
Retrieve all form definitions
|
List<FormMetadata> |
FormsApi.getFormDefinitionsMetadata(Integer $skip,
Integer $top,
String $inlinecount,
String type)
Retrieve all form definitions
|
FormMetadata |
UserTaskInstancesApi.getFormMetadata(String taskInstanceId)
Retrieve form metadata of the given task instance.
|
FormModel |
UserTaskInstancesApi.getFormModel(String taskInstanceId)
Retrieve form model of the given task instance.
|
WorkflowInstance |
WorkflowInstancesApi.getInstance(String workflowInstanceId)
Retrieve workflow instance by ID
|
TaskInstance |
UserTaskInstancesApi.getInstance(String taskInstanceId)
Retrieve task by ID
|
WorkflowInstance |
WorkflowInstancesApi.getInstance(String workflowInstanceId,
String acceptLanguage,
String $expand)
Retrieve workflow instance by ID
|
TaskInstance |
UserTaskInstancesApi.getInstance(String taskInstanceId,
String acceptLanguage,
String $expand)
Retrieve task by ID
|
AttachmentsContext |
WorkflowInstancesApi.getInstanceAttachments(String workflowInstanceId)
Retrieve instance attachments
|
AttachmentsContext |
UserTaskInstancesApi.getInstanceAttachments(String taskInstanceId)
Retrieve task instance attachments
|
List<CustomAttribute> |
WorkflowInstancesApi.getInstanceAttributes(String workflowInstanceId)
Retrieve custom workflow attributes by workflow instance ID
|
List<CustomAttribute> |
UserTaskInstancesApi.getInstanceAttributes(String taskInstanceId)
Retrieve custom task attributes by task instance ID
|
List<CustomAttribute> |
WorkflowInstancesApi.getInstanceAttributes(String workflowInstanceId,
String acceptLanguage)
Retrieve custom workflow attributes by workflow instance ID
|
List<CustomAttribute> |
UserTaskInstancesApi.getInstanceAttributes(String taskInstanceId,
String acceptLanguage)
Retrieve custom task attributes by task instance ID
|
Object |
WorkflowInstancesApi.getInstanceContext(String workflowInstanceId)
Retrieve instance context
|
Object |
UserTaskInstancesApi.getInstanceContext(String taskInstanceId)
Retrieve task context by ID
|
List<WorkflowInstanceErrorMessage> |
WorkflowInstancesApi.getInstanceErrorMessages(String workflowInstanceId)
Retrieve error messages
|
WorkflowInstanceRoles |
WorkflowInstancesApi.getInstanceRoles(String workflowInstanceId)
Retrieve instance roles
|
Job |
JobsApi.getJob(String jobId)
Retrieve Job status
|
FormModel |
FormsApi.getModelByIdAndRevision(String formId,
String revisionId)
Retrieve form model by ID and revision.
|
FormModel |
FormsApi.getModelByIdAndVersion(String formId,
String versionNumber)
Retrieve form model by ID and version number.
|
WorkflowModel |
WorkflowDefinitionsApi.getModelForDefinition(String definitionId)
Retrieve workflow definition model by ID
|
WorkflowModel |
WorkflowDefinitionsApi.getModelForDefinitionVersion(String definitionId,
String versionNumber)
Retrieve workflow definition model by ID and version number
|
RestResponse |
PurgeApi.purge()
Purge instances and definitions
|
List<Object> |
TaskDefinitionsApi.queryDefinitions()
Retrieve definitions by query parameters
|
List<WorkflowDefinition> |
WorkflowDefinitionsApi.queryDefinitions()
Retrieve all workflow definitions
|
List<Object> |
TaskDefinitionsApi.queryDefinitions(String acceptLanguage,
Integer $skip,
Integer $top,
String $inlinecount,
String $expand)
Retrieve definitions by query parameters
|
List<WorkflowDefinition> |
WorkflowDefinitionsApi.queryDefinitions(String acceptLanguage,
String $orderby,
Integer $skip,
Integer $top,
String $inlinecount)
Retrieve all workflow definitions
|
List<WorkflowInstanceExecutionLog> |
WorkflowInstancesApi.queryInstanceExecutionLogs(String workflowInstanceId)
Retrieve execution logs
|
List<WorkflowInstanceExecutionLog> |
WorkflowInstancesApi.queryInstanceExecutionLogs(String workflowInstanceId,
String acceptLanguage)
Retrieve execution logs
|
List<WorkflowInstance> |
WorkflowInstancesApi.queryInstances()
Retrieve all instances by query parameters
|
List<TaskInstance> |
UserTaskInstancesApi.queryInstances()
Retrieve instances by query parameters
|
List<TaskInstance> |
UserTaskInstancesApi.queryInstances(String acceptLanguage,
Integer $skip,
Integer $top,
String $inlinecount,
String $expand,
String $orderby,
String workflowInstanceId,
String workflowDefinitionId,
String processor,
String id,
String activityId,
String description,
String subject,
String createdAt,
String createdFrom,
String createdUpTo,
String claimedAt,
String claimedFrom,
String claimedUpTo,
String completedAt,
String completedFrom,
String completedUpTo,
String lastChangedAt,
String lastChangedFrom,
String lastChangedUpTo,
String dueDate,
String dueDateFrom,
String dueDateUpTo,
String priority,
String status,
String recipientUsers,
String recipientGroups,
String containsText,
String attributesExampleCustomAttribute,
String definitionId)
Retrieve instances by query parameters
|
List<WorkflowInstance> |
WorkflowInstancesApi.queryInstances(String acceptLanguage,
String $orderby,
Integer $skip,
Integer $top,
String $inlinecount,
String $expand,
String id,
String definitionId,
String definitionVersion,
String status,
String startedAt,
String startedFrom,
String startedUpTo,
String completedAt,
String completedFrom,
String completedUpTo,
String startedBy,
String subject,
String containsText,
String businessKey,
String rootInstanceId,
String parentInstanceId,
String attributesExampleCustomAttribute)
Retrieve all instances by query parameters
|
List<ConsumingWorkflowInstance> |
MessagesApi.sendMessage(SendMessagePayload body)
Send message
|
RestResponse |
WorkflowInstancesApi.setInstanceAttachments(String workflowInstanceId,
AttachmentsContext body)
Overwrite instance attachments
|
RestResponse |
WorkflowInstancesApi.setInstanceContext(String workflowInstanceId,
Object body)
Overwrite instance context
|
WorkflowInstance |
WorkflowInstancesApi.startInstance(WorkflowInstanceStartPayload body)
Start a new instance
|
WorkflowInstance |
WorkflowInstancesApi.startInstance(WorkflowInstanceStartPayload body,
String acceptLanguage)
Start a new instance
|
RestResponse |
WorkflowDefinitionsApi.undeployDefinition(String definitionId)
Delete workflow definition
|
RestResponse |
WorkflowDefinitionsApi.undeployDefinition(String definitionId,
Boolean cascade)
Delete workflow definition
|
RestResponse |
FormsApi.undeployForm(String formId)
Delete a form.
|
RestResponse |
UserTaskInstancesApi.updateInstance(String taskInstanceId,
UpdateTaskInstancePayload body)
Update task by ID
|
RestResponse |
WorkflowInstancesApi.updateInstance(String workflowInstanceId,
WorkflowInstanceUpdatePayload body)
Update instance
|
RestResponse |
WorkflowInstancesApi.updateInstanceContext(String workflowInstanceId,
Object body)
Update instance context
|
RestResponse |
WorkflowInstancesApi.updateInstanceRoles(String workflowInstanceId,
WorkflowInstanceRolesUpdatePayload body)
Update instance roles
|
RestResponse |
WorkflowInstancesApi.updateInstances(List<WorkflowInstancesUpdatePayload> body)
Delete instance by ID
|
Copyright © 2021 SAP SE. All rights reserved.