SAP S/4HANA Cloud
SAP S/4HANA Cloud is an enterprise resource planning (ERP) system.
This component allows you to manage business partners, sales orders, materials, and other enterprise resources within SAP S/4HANA Cloud Public Edition.
API Documentation¶
This component was built using the SAP API Business Hub for SAP S/4HANA Cloud.
Connections¶
API Key (Sandbox) {#apikey}¶
Connect to SAP S/4HANA Cloud APIs via SAP API Business Hub sandbox for testing and development. This connection provides read-only access to sample data.
This connection authenticates with SAP S/4HANA Cloud APIs via the SAP API Business Hub sandbox environment. It is designed for testing and development purposes only and provides read-only access to sample data.
:::note[Sandbox Environment Only] This connection is intended for testing and development using the SAP API Business Hub sandbox. For production access to real SAP S/4HANA Cloud data, use the Basic Auth connection instead. :::
Prerequisites¶
- An SAP account with access to SAP API Business Hub
- API key generated from SAP API Business Hub
Setup Steps¶
To create an API key for the sandbox:
- Navigate to SAP API Business Hub and log in with SAP credentials.
- Click on the user profile icon in the top right corner.
- Select Settings or API Keys from the menu.
- Click Show API Key to reveal the existing key, or generate a new one if needed.
- Copy the API key and store it securely.
Configure the Connection¶
- SAP API Key: Enter the API key obtained from SAP API Business Hub.
- Base URL: Use the default sandbox URL:
https://sandbox.api.sap.com/s4hanacloud
| Input | Comments | Default |
|---|---|---|
| SAP API Key | API key from SAP API Business Hub. Log in at https://api.sap.com and access your API key from your account settings. | |
| Base URL | SAP API Business Hub sandbox URL. Use the default sandbox URL for testing. This connection is intended for sandbox environments only. | https://sandbox.api.sap.com/s4hanacloud |
Basic Auth {#sapbasicauth}¶
Basic Authentication connection for direct access to SAP S/4HANA Cloud Public Edition. Requires a Communication User configured in SAP.
This connection authenticates directly with an SAP S/4HANA Cloud Public Edition tenant using Basic Authentication.
:::note[Production Access] This connection is for direct tenant access to SAP S/4HANA Cloud Public Edition. It requires a Communication Arrangement configured by an SAP administrator. :::
Prerequisites¶
- SAP S/4HANA Cloud Public Edition tenant
- Administrator access to configure Communication Arrangements
- A Communication Scenario enabled for the required APIs (e.g.,
SAP_COM_0008for Business Partner API)
Setup Steps in SAP S/4HANA Cloud¶
To configure Basic Authentication access, an SAP administrator must complete these steps:
- Create a Communication User
- Navigate to the Maintain Communication Users app
- Create a new user for API access
-
Set a secure password and note the credentials
-
Create a Communication System
- Navigate to the Communication Systems app
- Create a new system representing the external integration
- Under Users for Inbound Communication, add the Communication User created above
-
Ensure User ID and Password (Basic Authentication) is enabled
-
Create a Communication Arrangement
- Navigate to the Communication Arrangements app
- Create a new arrangement based on the required Communication Scenario
- Select the Communication System created above
- Verify the inbound services are enabled
Configure the Connection¶
- Tenant URL: The SAP S/4HANA Cloud tenant URL
-
Example:
https://my123456-api.s4hana.cloud.sap -
Communication User: The Communication User name created in SAP S/4HANA Cloud
-
Example:
Username -
Password: The Communication User password
| Input | Comments | Default |
|---|---|---|
| Tenant URL | SAP S/4HANA Cloud API tenant URL (include -api in the hostname). | |
| Communication User | Communication User name from the Communication Arrangement in SAP S/4HANA Cloud. | |
| Password | Communication User password. |
OAuth 2.0 Authorization Code {#sapoauth}¶
Authenticate with an SAP S/4HANA Cloud Public Edition tenant using OAuth 2.0 Authorization Code flow. Provides full read/write access to business data.
This connection authenticates with an SAP S/4HANA Cloud Public Edition tenant using OAuth 2.0 Authorization Code flow. It provides full read/write access to business data and is recommended for production integrations.
:::note[Production Access] This connection is for direct tenant access to SAP S/4HANA Cloud Public Edition. It requires a Communication Arrangement configured by an SAP administrator with OAuth 2.0 enabled. :::
Prerequisites¶
- SAP S/4HANA Cloud Public Edition tenant
- Administrator access to configure Communication Arrangements
- A Communication Scenario enabled for the required APIs (e.g.,
SAP_COM_0008for Business Partner API) - An SAP user account with permissions to access the required APIs
Setup Steps in SAP S/4HANA Cloud¶
To configure OAuth 2.0 access, an SAP administrator must complete these steps:
- Create a Communication System
- Navigate to Communication Systems app
- Create a new system representing the external integration (e.g.,
ACME) -
Under Users for Inbound Communication, configure OAuth 2.0:
- Authentication Method: OAuth 2.0
- OAuth 2.0 Client ID: Enter a client identifier (e.g.,
ACME) - Client Type: Public Client (recommended) or Confidential Client
-
Create a Communication Arrangement
- Navigate to Communication Arrangements app
- Create a new arrangement based on the required Communication Scenario
- Select the Communication System created above
- Note the OAuth 2.0 Details from Inbound Communication:
- Client ID
Configure the Connection¶
Only two fields are required to configure this connection:
- Tenant ID: The SAP S/4HANA Cloud tenant identifier
- This is the prefix in your SAP URL (e.g.,
my123456frommy123456.s4hana.cloud.sap) -
Find this in your browser address bar when logged into SAP
-
Client ID: The OAuth 2.0 Client ID from the Communication Arrangement
-
Navigate to Inbound Communication and click OAuth 2.0 Details to view the Client ID
-
Scopes (optional): Space-separated OAuth scopes
- Leave empty to use default scopes
- Specify API-specific scopes if required by your Communication Arrangement
:::info[Finding OAuth 2.0 Details] In the Communication Arrangement, navigate to Inbound Communication and click OAuth 2.0 Details to view the Client ID. :::
Authorization Flow¶
When you connect using this method:
- Enter your Tenant ID and Client ID in the connection form
- Click Connect - you will be redirected to SAP's login page
- Log in with your SAP user credentials (your personal SAP username and password)
- Grant authorization for the integration to access SAP on your behalf
- You will be redirected back to complete the connection setup
:::tip[SAP Login Credentials] During the OAuth flow, you log in with your SAP user account credentials - not the Communication System credentials. Your SAP user must have the appropriate authorizations to access the APIs defined in the Communication Arrangement. :::
For detailed setup instructions, refer to:
This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.
| Input | Comments | Default |
|---|---|---|
| Tenant ID | The SAP S/4HANA Cloud tenant identifier. This is the prefix in your SAP URL (e.g., 'my123456' from my123456.s4hana.cloud.sap). Learn more | |
| Client ID | The OAuth Client ID from the Communication Arrangement. Navigate to Inbound Communication and click OAuth 2.0 Details to view the Client ID. Learn more | |
| Scopes | Space-separated OAuth scopes. Leave empty to use default scopes, or specify API scopes from your Communication Arrangement. |
Actions¶
Add Attachment {#addattachment}¶
Uploads an attachment to a business object using the file name, mime type of the attachment, business object type, and business object instance key.
| Input | Comments | Default |
|---|---|---|
| Request Body | Request Body | |
| Connection |
Add Item To Purchase Requisition {#additemtopurchaserequisition}¶
Adds an item to a purchase requisition using the purchase requisition number provided.
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| Purchase Requisition Number | Purchase Requisition Number | |
| Body | Request Body | {"PurchaseRequisition":"string","PurchaseRequisitionItem":"strin","PurchasingDocument":"string","PurchasingDocumentItem":"strin","PurReqnReleaseStatus":"st","PurchaseRequisitionType":"stri","PurchasingDocumentItemCategory":"s","PurchaseRequisitionItemText":"string","AccountAssignmentCategory":"s","Material":"string","MaterialGroup":"string","RequestedQuantity":"0","BaseUnit":"str","PurchaseRequisitionPrice":"0","PurReqnPriceQuantity":"0","MaterialGoodsReceiptDuration":"0","ReleaseCode":"s","PurchaseRequisitionReleaseDate":"/Date(1492041600000)/","PurchasingOrganization":"stri","PurchasingGroup":"str","Plant":"stri","CompanyCode":"stri","SupplyingPlant":"stri","OrderedQuantity":"0","DeliveryDate":"/Date(1492041600000)/","ProcessingStatus":"s","ExternalApprovalStatus":"s","PurchasingInfoRecord":"string","Supplier":"string","IsDeleted":"s","FixedSupplier":"string","RequisitionerName":"string","PurReqnItemCurrency":"strin","MaterialPlannedDeliveryDurn":"0","DelivDateCategory":"s","MultipleAcctAssgmtDistribution":"s","StorageLocation":"stri","PurReqnSSPRequestor":"string","PurReqnSSPAuthor":"string","PurchaseContract":"string","PurchaseContractItem":"strin","ConsumptionPosting":"s","PurReqnOrigin":"s","PurReqnSSPCatalog":"string","PurReqnSSPCatalogItem":"string","PurReqnSSPCrossCatalogItem":0,"IsPurReqnBlocked":"s","ItemDeliveryAddressID":"string","Language":"st","IsClosed":true,"ReleaseIsNotCompleted":true,"ServicePerformer":"string","ProductType":"st","PurchaseRequisitionStatus":"string","ReleaseStrategy":"st","PerformancePeriodStartDate":"/Date(1492041600000)/","PerformancePeriodEndDate":"/Date(1492041600000)/","PurchaseOrderPriceType":"s","SupplierMaterialNumber":"string","Batch":"string","MaterialRevisionLevel":"st","MinRemainingShelfLife":"0","ItemNetAmount":"0","GoodsReceiptIsExpected":true,"InvoiceIsExpected":true,"GoodsReceiptIsNonValuated":true,"RequirementTracking":"string","MRPController":"str","TaxCode":"st","PurchaseRequisitionIsFixed":true,"ExpectedOverallLimitAmount":"0","OverallLimitAmount":"0","PurContractForOverallLimit":"string","PurReqnExternalReference":"string","PurReqnItemExternalReference":"string","PurReqnExternalSystemId":"string","PurReqnExternalSystemType":"s","PurReqnTypeExternalReference":"stri","PurReqnProcessingType":"s","PurReqnProcessingDateTime":"string","ProcmtHubBackendBusSyst":"string","SSPAuthorExternalBPIdnNumber":"string","SSPReqrUserId":"string","to_PurchaseReqn":{"PurchaseRequisition":"string","PurchaseRequisitionType":"stri","PurReqnDescription":"string","SourceDetermination":true,"PurReqnDoOnlyValidation":true,"to_PurchaseReqnItem":{"results":["string"]}},"to_PurchaseReqnAcctAssgmt":{"results":[{"PurchaseRequisition":"string","PurchaseRequisitionItem":"strin","PurchaseReqnAcctAssgmtNumber":"st","CostCenter":"string","MasterFixedAsset":"string","ProjectNetwork":"string","Quantity":"0","MultipleAcctAssgmtDistrPercent":"0","PurReqnNetAmount":"0","IsDeleted":"s","CostElement":"string","GLAccount":"string","BusinessArea":"stri","SDDocument":"string","SalesOrder":"string","SalesDocumentItem":"string","SalesOrderItem":"string","ScheduleLine":"stri","SalesOrderScheduleLine":"stri","FixedAsset":"stri","ProcessOrder":"string","OrderID":"string","UnloadingPointName":"string","ControllingArea":"stri","CostObject":"string","ProfitabilitySegment":"string","ProfitCenter":"string","ProjectNetworkInternalID":"string","CommitmentItem":"string","FundsCenter":"string","Fund":"string","FunctionalArea":"string","CreationDate":"/Date(1492041600000)/","GoodsRecipientName":"string","RealEstateObject":"string","NetworkActivityInternalID":"string","PartnerAccountNumber":"string","JointVentureRecoveryCode":"st","SettlementReferenceDate":"/Date(1492041600000)/","OrderInternalID":"string","OrderIntBillOfOperationsItem":"string","EarmarkedFundsDocument":"string","CostCtrActivityType":"string","BusinessProcess":"string","GrantID":"string","ValidityDate":"/Date(1492041600000)/","ChartOfAccounts":"stri","WBSElement":"string","NetworkActivity":"stri","PurchaseRequisitionType":"stri","Plant":"stri","PurchasingOrganization":"stri","PurchasingGroup":"str"}]},"to_PurchaseReqnDeliveryAddress":{"PurchaseRequisition":"string","PurchaseRequisitionItem":"strin","Plant":"stri","CareOfName":"string","AdditionalStreetSuffixName":"string","CorrespondenceLanguage":"st","PrfrdCommMediumType":"str","POBox":"string","POBoxIsWithoutNumber":true,"POBoxPostalCode":"string","POBoxLobbyName":"string","POBoxDeviatingCityName":"string","POBoxDeviatingRegion":"str","POBoxDeviatingCountry":"str","DeliveryServiceTypeCode":"stri","DeliveryServiceNumber":"string","AddressTimeZone":"string","CityName":"string","District":"string","CityCode":"string","HomeCityName":"string","PostalCode":"string","CompanyPostalCode":"string","StreetName":"string","StreetPrefixName":"string","AdditionalStreetPrefixName":"string","StreetSuffixName":"string","HouseNumber":"string","HouseNumberSupplementText":"string","Building":"string","Floor":"string","RoomNumber":"string","Country":"str","Region":"str","County":"string","FormOfAddress":"stri","BusinessPartnerName1":"string","BusinessPartnerName2":"string","Nation":"s","PhoneNumber":"string","FaxNumber":"string","SearchTerm1":"string","StreetSearch":"string","CitySearch":"string","BusinessPartnerName3":"string","BusinessPartnerName4":"string","TaxJurisdiction":"string","TransportZone":"string","Person":"string"},"to_PurchaseReqnItemText":{"results":[{"PurchaseRequisition":"string","PurchaseRequisitionItem":"strin","DocumentText":"stri","TechnicalObjectType":"string","Language":"st","NoteDescription":"string"}]}} |
Create Change Record {#createchangerecord}¶
Creates a change record.
| Input | Comments | Default |
|---|---|---|
| Body | Request Body | { |
| Connection | ||
| Project ID | Project ID |
Create Project {#createproject}¶
Creates a customer or internal project based on the level of information you provide.
| Input | Comments | Default |
|---|---|---|
| Body | Request Body | { |
| Connection |
Create Purchase Requisition {#createpurchaserequisition}¶
Creates a purchase requisition with one or more items.
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| Body | Request Body | {"PurchaseRequisition":"string","PurchaseRequisitionType":"string","PurReqnDescription":"string","SourceDetermination":true,"PurReqnDoOnlyValidation":true,"to_PurchaseReqnItem":{"results":[{"PurchaseRequisition":"string","PurchaseRequisitionItem":"strin","PurchasingDocument":"string","PurchasingDocumentItem":"strin","PurReqnReleaseStatus":"st","PurchaseRequisitionType":"stri","PurchasingDocumentItemCategory":"s","PurchaseRequisitionItemText":"string","AccountAssignmentCategory":"s","Material":"string","MaterialGroup":"string","RequestedQuantity":"0","BaseUnit":"str","PurchaseRequisitionPrice":"0","PurReqnPriceQuantity":"0","MaterialGoodsReceiptDuration":"0","ReleaseCode":"s","PurchaseRequisitionReleaseDate":"/Date(1492041600000)/","PurchasingOrganization":"stri","PurchasingGroup":"str","Plant":"stri","CompanyCode":"stri","SupplyingPlant":"stri","OrderedQuantity":"0","DeliveryDate":"/Date(1492041600000)/","ProcessingStatus":"s","ExternalApprovalStatus":"s","PurchasingInfoRecord":"string","Supplier":"string","IsDeleted":"s","FixedSupplier":"string","RequisitionerName":"string","PurReqnItemCurrency":"strin","MaterialPlannedDeliveryDurn":"0","DelivDateCategory":"s","MultipleAcctAssgmtDistribution":"s","StorageLocation":"stri","PurReqnSSPRequestor":"string","PurReqnSSPAuthor":"string","PurchaseContract":"string","PurchaseContractItem":"strin","ConsumptionPosting":"s","PurReqnOrigin":"s","PurReqnSSPCatalog":"string","PurReqnSSPCatalogItem":"string","PurReqnSSPCrossCatalogItem":0,"IsPurReqnBlocked":"s","ItemDeliveryAddressID":"string","Language":"st","IsClosed":true,"ReleaseIsNotCompleted":true,"ServicePerformer":"string","ProductType":"st","PurchaseRequisitionStatus":"string","ReleaseStrategy":"st","PerformancePeriodStartDate":"/Date(1492041600000)/","PerformancePeriodEndDate":"/Date(1492041600000)/","PurchaseOrderPriceType":"s","SupplierMaterialNumber":"string","Batch":"string","MaterialRevisionLevel":"st","MinRemainingShelfLife":"0","ItemNetAmount":"0","GoodsReceiptIsExpected":true,"InvoiceIsExpected":true,"GoodsReceiptIsNonValuated":true,"RequirementTracking":"string","MRPController":"str","TaxCode":"st","PurchaseRequisitionIsFixed":true,"ExpectedOverallLimitAmount":"0","OverallLimitAmount":"0","PurContractForOverallLimit":"string","PurReqnExternalReference":"string","PurReqnItemExternalReference":"string","PurReqnExternalSystemId":"string","PurReqnExternalSystemType":"s","PurReqnTypeExternalReference":"stri","PurReqnProcessingType":"s","PurReqnProcessingDateTime":"string","ProcmtHubBackendBusSyst":"string","SSPAuthorExternalBPIdnNumber":"string","SSPReqrUserId":"string","to_PurchaseReqn":"string","to_PurchaseReqnAcctAssgmt":{"results":[{"PurchaseRequisition":"string","PurchaseRequisitionItem":"strin","PurchaseReqnAcctAssgmtNumber":"st","CostCenter":"string","MasterFixedAsset":"string","ProjectNetwork":"string","Quantity":"0","MultipleAcctAssgmtDistrPercent":"0","PurReqnNetAmount":"0","IsDeleted":"s","CostElement":"string","GLAccount":"string","BusinessArea":"stri","SDDocument":"string","SalesOrder":"string","SalesDocumentItem":"string","SalesOrderItem":"string","ScheduleLine":"stri","SalesOrderScheduleLine":"stri","FixedAsset":"stri","ProcessOrder":"string","OrderID":"string","UnloadingPointName":"string","ControllingArea":"stri","CostObject":"string","ProfitabilitySegment":"string","ProfitCenter":"string","ProjectNetworkInternalID":"string","CommitmentItem":"string","FundsCenter":"string","Fund":"string","FunctionalArea":"string","CreationDate":"/Date(1492041600000)/","GoodsRecipientName":"string","RealEstateObject":"string","NetworkActivityInternalID":"string","PartnerAccountNumber":"string","JointVentureRecoveryCode":"st","SettlementReferenceDate":"/Date(1492041600000)/","OrderInternalID":"string","OrderIntBillOfOperationsItem":"string","EarmarkedFundsDocument":"string","CostCtrActivityType":"string","BusinessProcess":"string","GrantID":"string","ValidityDate":"/Date(1492041600000)/","ChartOfAccounts":"stri","WBSElement":"string","NetworkActivity":"stri","PurchaseRequisitionType":"stri","Plant":"stri","PurchasingOrganization":"stri","PurchasingGroup":"str"}]},"to_PurchaseReqnDeliveryAddress":{"PurchaseRequisition":"string","PurchaseRequisitionItem":"strin","Plant":"stri","CareOfName":"string","AdditionalStreetSuffixName":"string","CorrespondenceLanguage":"st","PrfrdCommMediumType":"str","POBox":"string","POBoxIsWithoutNumber":true,"POBoxPostalCode":"string","POBoxLobbyName":"string","POBoxDeviatingCityName":"string","POBoxDeviatingRegion":"str","POBoxDeviatingCountry":"str","DeliveryServiceTypeCode":"stri","DeliveryServiceNumber":"string","AddressTimeZone":"string","CityName":"string","District":"string","CityCode":"string","HomeCityName":"string","PostalCode":"string","CompanyPostalCode":"string","StreetName":"string","StreetPrefixName":"string","AdditionalStreetPrefixName":"string","StreetSuffixName":"string","HouseNumber":"string","HouseNumberSupplementText":"string","Building":"string","Floor":"string","RoomNumber":"string","Country":"str","Region":"str","County":"string","FormOfAddress":"stri","BusinessPartnerName1":"string","BusinessPartnerName2":"string","Nation":"s","PhoneNumber":"string","FaxNumber":"string","SearchTerm1":"string","StreetSearch":"string","CitySearch":"string","BusinessPartnerName3":"string","BusinessPartnerName4":"string","TaxJurisdiction":"string","TransportZone":"string","Person":"string"},"to_PurchaseReqnItemText":{"results":[{"PurchaseRequisition":"string","PurchaseRequisitionItem":"strin","DocumentText":"stri","TechnicalObjectType":"string","Language":"st","NoteDescription":"string"}]}}]}} |
Create Record {#createrecord}¶
Creates a new record in SAP S/4HANA OData V2. For OData V4 APIs, use Raw Request.
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| Record Type | Type of SAP S/4HANA Record, e.g: WorkItemSet | WorkItemSet |
| Body | Request Body | { |
Create Subscription {#createsubscription}¶
Creates business event subscriptions.
| Input | Comments | Default |
|---|---|---|
| Body | Request Body | { |
| Connection |
Delete Attachment {#deleteattachment}¶
Deletes the attachment associated with the business object using the document type, document number, document version, document part, logical document ID, archive document ID, business object type, and business object instance key.
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| Document Info Record Document Type | Document Info Record Document Type | |
| Document Info Record Document Number | Document Info Record Document Number | |
| Document Info Record Document Version | Document Info Record Document Version | |
| Document Info Record Document Part | Document Info Record Document Part | |
| Logical Document | Logical Document | |
| Archive Document ID | Archive Document ID | |
| Linked SAP Object Key | Linked SAP Object Key | |
| Business Object Type Name | Business Object Type Name |
Delete Record {#deleterecord}¶
Deletes an existing record in SAP S/4HANA OData V2. For OData V4 APIs, use Raw Request.
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| Record Type | Type of SAP S/4HANA Record, e.g: WorkItemSet | WorkItemSet |
| Record ID | ID number tied to the record | 12312313 |
Get Attachment {#getattachment}¶
Reads the attachments associated with a document info record.
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| Document Info Record Document Type | Document Info Record Document Type | |
| Document Info Record Document Number | Document Info Record Document Number | |
| Document Info Record Document Version | Document Info Record Document Version | |
| Document Info Record Document Part | Document Info Record Document Part | |
| Filter | Filter items by property values | |
| Inline Count | ||
| Order By | Order items by property value | |
| Select | Select property to be returned |
Get Change Records {#getchangerecord}¶
Reads data of a specific change record based on its universally unique identifier (UUID).
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| Change Record UUID | NodeID | |
| Select | Select property to be returned | |
| Expand | Expand property to be returned |
Get Project {#getproject}¶
Returns details about a customer or internal project.
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| Project ID | Project ID | |
| Select | Select property to be returned | |
| Expand | Expand to include related entities |
Get Purchase Requisition {#getpurchaserequisition}¶
Gets the header details of a purchase requisition using the purchase requisition number provided.
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| Select | Select property to be returned | |
| Expand | Expand property to be returned | |
| Purchase Requisition Number | Purchase Requisition Number |
Get Purchase Requisition Item Details {#getpurchaserequisitionitemdetails}¶
Gets the item details of all the items in a purchase requisition
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| Top | Show only the first n items | |
| Skip | Skip the first n items | |
| Filter | Filter items by property values | |
| Inline Count | ||
| Order By | Order items by property value | |
| Select | Select property to be returned | |
| Expand | Expand property to be returned | |
| Purchase Requisition Number | Purchase Requisition Number |
Get Record {#getrecord}¶
Retrieve a single record from SAP S/4HANA OData V2. For OData V4 APIs, use Raw Request.
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| Record Type | Type of SAP S/4HANA Record, e.g: WorkItemSet | WorkItemSet |
| Record ID | ID number tied to the record | 12312313 |
| Top | Show only the first n items | |
| Skip | Skip the first n items | |
| Filter | Filter items by property values | |
| Inline Count | ||
| Order By | Order items by property value | |
| Select | Select property to be returned | |
| Expand | Expand related entities |
List Change Records {#listchangerecords}¶
Retrieves the list of change records in the system.
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| Top | Show only the first n items | |
| Skip | Skip the first n items | |
| Filter | Filter items by property values | |
| Inline Count | ||
| Order By | Order items by property value | |
| Select | Select property to be returned | |
| Expand | Expand property to be returned |
List Files {#listfiles}¶
Retrieves list of prepared files, based on specific filter conditions.
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| Filter | Filter items by property values | |
| Inline Count | ||
| Select | Select property to be returned |
List Projects {#listprojects}¶
Returns details about all customer and internal projects in the system.
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| Filter | Filter items by property values | |
| Inline Count | ||
| Order By | Order by property | |
| Select | Select property to be returned | |
| Expand | Expand property to be returned |
List Purchase Requisitions {#listpurchaserequisitions}¶
Gets the header details of all the purchase requisitions in the system.
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| Top | Show only the first n items | |
| Skip | Skip the first n items | |
| Filter | Filter items by property values | |
| Inline Count | ||
| Order By | Order items by property value | |
| Select | Select property to be returned | |
| Expand | Expand property to be returned |
List Records {#listrecords}¶
Retrieve a list of records from SAP S/4HANA OData V2. For OData V4 APIs, use Raw Request.
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| Top | Show only the first n items | |
| Skip | Skip the first n items | |
| Filter | Filter items by property values | |
| Inline Count | ||
| Order By | Order items by property value | |
| Select | Select property to be returned | |
| Expand | Expand related entities | |
| Record Type | Type of SAP S/4HANA Record, e.g: WorkItemSet | WorkItemSet |
List Subscriptions {#listsubscriptions}¶
Reads subscription information for business events.
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| Top | Show only the first n items | |
| Skip | Skip the first n items | |
| Search | Search items by search phrases | |
| Filter | Filter items by property values | |
| Inline Count | ||
| Order By | Order by property | |
| Select | Select property to be returned |
List Timesheet Entry Collection {#listtimesheetentrycollection}¶
Reads data for all workforce’s timesheet entries. It retrieves information about the time recording made by each workforce’s on a particular task and on a particular day.
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| Top | Show only the first n items | |
| Skip | Skip the first n items | |
| Filter | Filter items by property values | |
| Inline Count | ||
| Order By | Order by property | |
| Select | Select property to be returned |
Raw Request {#rawrequest}¶
Send raw HTTP request to SAP S/4HANA
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| URL | Input the path only. The base URL from your connection is automatically prepended. For example: /sap/opu/odata4/sap/api_purchaseorder_2/srvd_a2x/sap/purchaseorder/0001/PurchaseOrder | |
| Method | The HTTP method to use. | |
| Data | The HTTP body payload to send to the URL. | |
| Form Data | The Form Data to be sent as a multipart form upload. | |
| File Data | File Data to be sent as a multipart form upload. | |
| File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | |
| Query Parameter | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | |
| Header | A list of headers to send with the request. | |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Timeout | The maximum time that a client will await a response to its request | |
| Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 |
| Retry On All Errors | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | false |
| Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | false |
Raw Request - OData {#rawrequestodata}¶
Send an OData GET request to SAP S/4HANA with query parameters
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| URL Path | Input the path only. The base URL from your connection is automatically prepended. Example: /sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionHeader | |
| Top | Show only the first n items | |
| Skip | Skip the first n items | |
| Search | Search items by search phrases | |
| Filter | Filter items by property values | |
| Inline Count | ||
| Order By | Order by property | |
| Select | Select property to be returned | |
| Expand | Expand property to be returned |
Update Change Record {#updatechangerecord}¶
Updates header attributes of the change record specified in the request.
| Input | Comments | Default |
|---|---|---|
| Body | Request Body | { |
| Connection | ||
| Change Record UUID | NodeID |
Update Project {#updateproject}¶
Updates the basic information for a customer or internal project.
| Input | Comments | Default |
|---|---|---|
| Body | Request Body | { |
| Connection | ||
| Project ID | Project ID |
Update Purchase Requisition {#updatepurchaserequisition}¶
Updates the header details of a purchase requisition.
| Input | Comments | Default |
|---|---|---|
| Body | Request Body | {"d":{"PurchaseRequisitionType":"string","PurReqnDescription":"string","SourceDetermination":true,"PurReqnDoOnlyValidation":true}} |
| Connection | ||
| Purchase Requisition Number | Purchase Requisition Number |
Update Record {#updaterecord}¶
Updates an existing record in SAP S/4HANA.
| Input | Comments | Default |
|---|---|---|
| Body | Request Body | { |
| Connection | ||
| Record Type | Type of SAP S/4HANA Record, e.g: WorkItemSet | WorkItemSet |
| Record ID | ID number tied to the record | 12312313 |
Update Subscription {#updatesubscription}¶
Updates business events subscription status using the business event subscriber code, SAP object type, SAP object task code, and business event subscription state code.
| Input | Comments | Default |
|---|---|---|
| Bus Event Subscriber Code | Subscriber ID | |
| SAP Object Type | SAP Object Type | |
| SAP Object Task Code | SAP Object Task Code | |
| Body | Request Body | { |
| Connection |
Update Timesheet Entry Collection {#updatetimesheetentrycollection}¶
Creates, updates, or deletes workforce timesheet entry based on the data provided in payload.
| Input | Comments | Default |
|---|---|---|
| Body | Request Body | { |
| Connection |