com.sap.cloud.sdk.services.scp.workflow.cf.api

Class MessagesApi

java.lang.Object

com.sap.cloud.sdk.services.rest.core.AbstractRestService

com.sap.cloud.sdk.services.scp.workflow.cf.api.MessagesApi

All Implemented Interfaces:

RestService

@Component(value="com.sap.cloud.sdk.services.scp.workflow.cf.api.MessagesApi")
 @Beta
public class MessagesApi
extends AbstractRestService

Workflow API for Cloud Foundry in version v1. This API in the Cloud SDK uses the SAP Cloud Platform Workflow service REST API. With the API, you can, for example, start new workflow instances and work with tasks.
For more information on how to obtain the necessary parameters, please see Determine Service Configuration Parameters in the documentation. The OAuth client you use must have extended scopes.
Note: The underlying REST APIs are designed for loosely coupled clients. This means:

• If workflow service adds fields to responses, the REST API version number does not increase. REST API clients must ignore new fields. These fields become available in the Workflow API in the Cloud SDK only in new versions of the SDK.
• The order of fields in responses and of entries in arrays may change. This applies unless the API provides an explicit means to specify the desired order.

Field Summary

Fields inherited from class com.sap.cloud.sdk.services.rest.core.AbstractRestService

apiClient

Constructor Summary

Constructors

Constructor and Description
MessagesApi(HttpDestinationProperties httpDestination) Instantiates this API class to invoke operations on the the Workflow API for Cloud Foundry.

Method Summary

Modifier and Type	Method and Description
List<ConsumingWorkflowInstance>	sendMessage(SendMessagePayload body) Send message

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessagesApi

public MessagesApi(@Nonnull
                   HttpDestinationProperties httpDestination)

Instantiates this API class to invoke operations on the the Workflow API for Cloud Foundry.

Parameters:

httpDestination - The destination that API should be used with

Method Detail

sendMessage

@Nullable
public List<ConsumingWorkflowInstance> sendMessage(@Nonnull
                                                             SendMessagePayload body)
                                                      throws RestRequestException

Send message

Sends a message to a set of workflow instances for consumption in intermediate message events. The message is identified by the name specified in the workflow model (request body parameter 'definitionId') and parameters identifying the workflow instances that should consume the message. The message is consumed by the workflow instances that match the following criteria: * The instance can be a specific match when using its workflow instance ID (request body parameter 'workflowInstanceId'). Or the instance is a generic match when using the ID of the workflow model together with the business key (request body parameters 'workflowDefinitionId' respectively 'businessKey'). You can either use the specific or generic match but not both in the same call. * The workflow instance is not in the SUSPENDED state. * The workflow instance currently waits at the intermediate message event referring to the specified message. The business key of a workflow instance matches if the business key specified in the request body is the same. Roles permitted to execute this operation: - Global roles: WorkflowMessageSender - Scope: MESSAGE_SEND

200 - Returns a list of workflow instance IDs that consumed the message.

403 - Access forbidden. You do not have the required permissions to access the resource.

422 - The message was not consumed by the intermediate message event. Please see the messages API to verify that your message meets the requirements for successful consumption.

429 - You have reached the usage limits that are configured for your tenant. You are performing too many requests or consume too many resources.

500 - Internal server error. The operation you requested led to an error during execution.

Parameters:

body - Specify the request body according to the given schema. The length of the request body is limited to ensure optimal operation of the service.

Returns:

List<ConsumingWorkflowInstance>

Throws:

RestRequestException - if an error occurs while attempting to invoke the API