Get Record

Description

Retrieves a single record from an SAP Business Object using its unique record identifier.

The activity uses SAP OData APIs and supports SAP systems that expose OData services, including SAP HANA Cloud and SAP on-premises environments.

Use Get Record when the identifier of the record is already known. To retrieve multiple records or search for records using filter criteria, use the Get Records activity.

---

Common settings

Use Process Data to bind supported inputs to workflow values or upstream outputs. See Common Activity Features for shared execution, error-handling, and output-persistence settings. Availability depends on the activity.

Design-Time Configuration

Display Text

A user-defined name for the activity, displayed on the workflow canvas to help identify its purpose.

Connection Name

The configured SAP connection used to access the SAP system.

The connection determines the SAP system and the OData services available to the activity.

If you have not yet created or configured an SAP connection, see SAP Connection.

Service

The SAP OData service containing the Business Object you want to access.

The available services are retrieved based on the selected SAP connection.

Business Object

The Business Object containing the record you want to retrieve.

The available Business Objects depend on the selected Service.

Record Identifier (Key)

The unique identifier of the record to retrieve.

You can provide the identifier directly or configure it dynamically using Process Data.

---

OData Version

Specifies the OData protocol version used to communicate with the selected SAP service.

Option	Description
Auto	Automatically determines the appropriate OData version based on the configured connection URL. This is the default option.
OData V2	Uses the OData V2 protocol to communicate with the SAP service.
OData V4	Uses the OData V4 protocol to communicate with the SAP service.

tip

Use the default Auto option unless you specifically need to force the activity to use OData V2 or OData V4.

Timeout

Maximum HTTP request duration in seconds. The default 0 uses the selected connection's timeout. Set a positive value to override it for this activity.

Execution settings

Configure Wait All Incoming when execution paths converge, and On Error for failure handling. Select Inherit where available to use the workflow-level error policy.

Fields

The Fields tab allows you to select the fields to retrieve from the selected SAP Business Object.

The available fields are dynamically populated based on the selected Business Object.

Select only the fields required by your workflow to avoid retrieving unnecessary data.

The values of the selected fields are returned as part of the Record output and can be accessed by downstream activities.

---

Output

Record

The SAP Business Object record retrieved using the specified Record Identifier.

The Record contains the fields selected in the Fields tab and can be used by downstream activities through Activity Outputs.

ETag

The version tag returned by SAP, when available. Use it as If-Match ETag when a later update/delete uses ETag Mode = Provided.

Related data (Expand)

Use Expand to request supported navigation properties with the record, such as to_MaterialDocumentItem. Choose only the related data needed by the workflow.

Remarks

• The available Business Objects depend on the selected Service.

• The available fields in the Fields tab depend on the selected Business Object.

• The authenticated SAP user must have permission to read the selected Business Object.

• Auto is the default OData Version and automatically determines the appropriate OData version based on the configured connection URL.

• Use Get Record when the unique identifier of the record is known.

• Use Get Records when multiple records need to be retrieved or records need to be selected using filter criteria.

Example: Retrieve a composite key

Select the service and Business Object. Supply Key using the technical key names and values, for example:

MaterialDocument='4900000123',MaterialDocumentYear='2024'

Select the required fields and run the activity. Bind Record fields to subsequent steps. A missing entity or rejected key is an activity error, not a successful record with default values.