@sap/cloud-sdk-workflow-service-cf

This package contains the OpenAPI client for the SAP Workflow API. This API uses the SAP Workflow service. With the API, you can, for example, start new workflow instances and work with tasks.

Note (relevant only for SAP API Business Hub): For authentication purposes, the API uses OAuth 2.0 security (with JSON Web Token, JWT). Thus, "Try Out" only works with an explicitly configured environment. 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: These APIs are designed for loosely coupled clients. This means:

If workflow service adds fields to responses, the API version number does not increase. Your client must ignore new fields.
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.

Usage Example

import { WorkflowInstancesApi } from '@sap/cloud-sdk-workflow-service-cf';

const responseData = await WorkflowInstancesApi.queryInstances().execute({ destinationName:'myDestinationName' });