Appearance
sap.list-business-partners ​
List SAP business partners (id, name, category, roles) for matching
List business partners (five fields only) through the org's SAP connection.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-sap |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Authenticated organization UUID injected by the workflow boundary |
connection_uuid | uuid | Yes | — | Organization-scoped SAP CloudConnection UUID |
workflow_run_id | string | No | — | Engine-stamped parent DAG run id |
skip | integer | No | 0 | Zero-based OData $skip |
top | integer | No | 50 | OData $top page size (1..1000) |
search_text | string | No | — | Substring match on the partner name |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Authenticated organization UUID injected by the workflow boundary |
connection_uuid | uuid | Yes | — | Organization-scoped SAP CloudConnection UUID |
workflow_run_id | string | No | — | Engine-stamped parent DAG run id |
skip | integer | No | 0 | Zero-based OData $skip |
top | integer | No | 50 | OData $top page size (1..1000) |
search_text | string | No | — | Substring match on the partner name |
business_partners | list | Yes | — | partner_ref, partner_name, partner_category, is_customer, is_supplier — nothing else |
record_count | integer | Yes | — | — |
sap_environment | string | No | — | Which SAP data set the records came from: 'sandbox' (Business Accelerator Hub canned data) or 'live'. Sourced from the connection, never from caller input. Persisted evidence must be partitioned by this value. |
listed_at | string | Yes | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_step | json | No | — | — |
failed_layer | integer | No | — | — |
failed_at_state | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
failed_at | string | No | — | — |
provider_request_ref | string | No | — | — |
retryable | boolean | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
done | Yes | Yes | Yes | — | — |
Outcomes ​
| Outcome | Type | Description | State Data Keys |
|---|---|---|---|
listed | SUCCESS | Business partners were listed | business_partners, record_count, sap_environment |
failed | FAILURE | The listing failed | failure_reason, failure_type, retryable |
Business Errors ​
| Code | Message Template |
|---|---|
SAP_ORGANIZATION_CONTEXT_INVALID | Authenticated organization context is missing or does not match the workflow input |
SAP_CONNECTION_NOT_FOUND | SAP connection {connection_uuid} was not found in the authenticated organization |
SAP_CONNECTION_WRONG_PROVIDER | Connection {connection_uuid} is not a SAP connection |
SAP_CONNECTION_SERVICE_UNAVAILABLE | The shared cloud connection service is unavailable |
SAP_PROVIDER_CAPABILITY_MISSING | The installed SAP provider does not expose the required API operation |
SAP_AUTHENTICATION_FAILED | SAP rejected the connection credentials or API key |
SAP_PROVIDER_REQUEST_FAILED | The SAP OData request failed |
SAP_RESPONSE_SHAPE_INVALID | The SAP OData API returned an invalid response |
SAP_PAGINATION_INVALID | skip must be a non-negative integer and top must be between 1 and 1000 |
SAP_WINDOW_INVALID | Dates must use YYYY-MM-DD and be ordered |
SAP_SIDE_INVALID | side must be exactly 'receivable' or 'payable' |
SAP_ENVIRONMENT_INVALID | The connection's SAP environment must be exactly 'sandbox' or 'live' |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "sap.list-business-partners",
"initial_data": {
"organization_uuid": "value",
"connection_uuid": "value"
}
}