SAP S/4HANA Cloud Component
SAP S/4HANA is a multi-faceted cloud based ERP solution. Use the S/4HANA component to manage records within the SAP database.
Component key: sapS4Hana
Description
SAP S/4HANA is a multi-faceted cloud based ERP solution.
Use the S/4HANA component to manage records within the SAP database.
Connections
API Key
You can create an API key within a single environment and use the API key to execute different public endpoints bound to this specific environment.
While creating an API key, you will be able to see the complete API key and copy/paste into your connection. As a best practice, you must store the API key in a safe place so that you can retrieve it in the future. You won’t be able to copy/paste the key once it is added to your environment. Refer to SAP Help Portal for additional Information.
Perform the following steps to create API keys within a single environment.
- Go to the Environments tab and click an environment to open it.
- Go to the API Keys section and click Add API Key.
- In the General section of Generate New API Key window, enter API key name on the Name field and description (optional) on the Description field. Click Next.
- In the Scope section of Generate New API Key window, click the toggle button(s) to choose single or multiple scopes of your API key. Click Next.
- In the Review section of Generate New API Key window, you can review your API key. Click Add. The Generated Key dialog box is displayed.
- Click Copy. The API key will be copied to the clipboard and you can paste it into the connection. You can also select the API key manually and copy it.
| Input | Notes | Example |
|---|---|---|
| SAP API Key | Follow the next steps to get an API key https://help.sap.com/docs/intelligent-robotic-process-automation/factory-user-guide/add-api-keys-to-environment | |
| Base URL | Provide the Base URL for the organization. Example https://{company-url}.api.sap.com/s4hanacloud |
Actions
Add Attachment
Uploads an attachment to a business object using the file name, mime type of the attachment, business object type, and business object instance key. | key: addAttachment
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Request Body | Request Body |
Add Item To Purchase Requisition
Adds an item to a purchase requisition using the purchase requisition number provided. | key: addItemToPurchaseRequisition
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Purchase Requisition Number | Purchase Requisition Number | |
| Body | Request Body |
Create Change Record
Creates a change record. | key: createChangeRecord
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Project ID | Project ID | |
| Body | Request Body |
Create Project
Creates a customer or internal project based on the level of information you provide. | key: createProject
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Body | Request Body |
Create Purchase Requisition
Creates a purchase requisition with one or more items. | key: createPurchaseRequisition
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Body | Request Body |
Create Record
Creates a new record in SAP S/4HANA. | key: createRecord
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Record Type | Type of SAP S/4HANA Record, e.g: WorkItemSet | WorkItemSet |
| Body | Request Body |
Create Subscription
Creates business event subscriptions. | key: createSubscription
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Body | Request Body |
Delete Attachment
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. | key: deleteAttachment
| Input | Notes | Example |
|---|---|---|
| Archive Document ID | Archive Document ID | |
| Business Object Type Name | Business Object Type Name | |
| Connection | ||
| Document Info Record Document Number | Document Info Record Document Number | |
| Document Info Record Document Part | Document Info Record Document Part | |
| Document Info Record Document Type | Document Info Record Document Type | |
| Document Info Record Document Version | Document Info Record Document Version | |
| Linked SAP Object Key | Linked SAP Object Key | |
| Logical Document | Logical Document |
Delete Record
Deletes an existing record in SAP S/4HANA. | key: deleteRecord
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Record ID | ID number tied to the record | 12312313 |
| Record Type | Type of SAP S/4HANA Record, e.g: WorkItemSet | WorkItemSet |
Get Attachment
Reads the attachments associated with a document info record. | key: getAttachment
| Input | Notes | Example |
|---|---|---|
| Order By | Order items by property value | |
| Select | Select property to be returned | |
| Connection | ||
| Document Info Record Document Number | Document Info Record Document Number | |
| Document Info Record Document Part | Document Info Record Document Part | |
| Document Info Record Document Type | Document Info Record Document Type | |
| Document Info Record Document Version | Document Info Record Document Version | |
| Filter | Filter items by property values | |
| Inline Count |
Get Change Records
Reads data of a specific change record based on its universally unique identifier (UUID). | key: getChangerecord
| Input | Notes | Example |
|---|---|---|
| Expand | Expand property to be returned | |
| Select | Select property to be returned | |
| Change Record UUID | NodeID | |
| Connection |
Get Project
Returns details about a customer or internal project. | key: getProject
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Expand | Expand to include related entities | |
| Project ID | Project ID | |
| Select | Select property to be returned |
Get Purchase Requisition
Gets the header details of a purchase requisition using the purchase requisition number provided. | key: getPurchaseRequisition
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Expand | Expand property to be returned | |
| Purchase Requisition Number | Purchase Requisition Number | |
| Select | Select property to be returned |
Get Purchase Requisition Item Details
Gets the item details of all the items in a purchase requisition | key: getPurchaseRequisitionItemDetails
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Expand | Expand property to be returned | |
| Filter | Filter items by property values | |
| Inline Count | ||
| Order By | Order items by property value | |
| Purchase Requisition Number | Purchase Requisition Number | |
| Select | Select property to be returned | |
| Skip | Skip the first n items | |
| Top | Show only the first n items |
Get Record
Retrieve a single record from SAP S/4HANA | key: getRecord
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Expand | Expand related entities | |
| Filter | Filter items by property values | |
| Inline Count | ||
| Order By | Order items by property value | |
| Record ID | ID number tied to the record | 12312313 |
| Record Type | Type of SAP S/4HANA Record, e.g: WorkItemSet | WorkItemSet |
| Select | Select property to be returned | |
| Skip | Skip the first n items | |
| Top | Show only the first n items |
List Change Records
Retrieves the list of change records in the system. | key: listChangeRecords
| Input | Notes | Example |
|---|---|---|
| Expand | Expand property to be returned | |
| Order By | Order items by property value | |
| Select | Select property to be returned | |
| Connection | ||
| Filter | Filter items by property values | |
| Inline Count | ||
| Skip | Skip the first n items | |
| Top | Show only the first n items |
List Files
Retrieves list of prepared files, based on specific filter conditions. | key: listFiles
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Filter | Filter items by property values | |
| Inline Count | ||
| Select | Select property to be returned | Available values (use one): PackageName, FileName, ObjectName, Scenario, FileSize |
List Projects
Returns details about all customer and internal projects in the system. | key: listProjects
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Expand | Expand property to be returned | |
| Filter | Filter items by property values | |
| Inline Count | ||
| Order By | Order by property | |
| Select | Select property to be returned |
List Purchase Requisitions
Gets the header details of all the purchase requisitions in the system. | key: listPurchaseRequisitions
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Expand | Expand property to be returned | |
| Filter | Filter items by property values | |
| Inline Count | ||
| Order By | Order items by property value | |
| Select | Select property to be returned | |
| Skip | Skip the first n items | |
| Top | Show only the first n items |
List Records
Retrieve a list of records from SAP S/4HANA. | key: listRecords
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Expand | Expand related entities | Available values (use one): ProjectRoleSet, WorkPackageSet |
| Filter | Filter items by property values | |
| Inline Count | ||
| Order By | Order items by property value | Available values (use one): FileSize, FileSize desc, FileName, FileName desc, MimeType, MimeType desc, CreatedByUser, CreatedByUser desc, CreationDateTime, CreationDateTime desc, LastChangedByUser, LastChangedByUser desc, ChangedDateTime, ChangedDateTime desc |
| Record Type | Type of SAP S/4HANA Record, e.g: WorkItemSet | WorkItemSet |
| Select | Select property to be returned | Available values (use one): DocumentInfoRecordDocType, DocumentInfoRecordDocNumber, DocumentInfoRecordDocVersion, DocumentInfoRecordDocPart, LogicalDocument, ArchiveDocumentID, LinkedSAPObjectKey, BusinessObjectTypeName, SemanticObject, WorkstationApplication, FileSize, FileName, DocumentURL, MimeType, Content, CreatedByUser, CreatedByUserFullName, CreationDateTime, BusinessObjectType, LastChangedByUser, LastChangedByUserFullName, ChangedDateTime, StorageCategory, ArchiveLinkRepository, SAPObjectType, SAPObjectNodeType, HarmonizedDocumentType, AttachmentDeletionIsAllowed, AttachmentRenameIsAllowed, Source, AttachmentContentHash |
| Skip | Skip the first n items | |
| Top | Show only the first n items |
List Subscriptions
Reads subscription information for business events. | key: listSubscriptions
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Filter | Filter items by property values | |
| Inline Count | ||
| Order By | Order by property | |
| Search | Search items by search phrases | |
| Select | Select property to be returned | |
| Skip | Skip the first n items | |
| Top | Show only the first n items |
List Timesheet Entry Collection
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. | key: listTimesheetEntryCollection
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Filter | Filter items by property values | |
| Inline Count | ||
| Order By | Order by property | |
| Select | Select property to be returned | |
| Skip | Skip the first n items | |
| Top | Show only the first n items |
Raw Request
Send raw HTTP request to SAP S/4HANA | key: rawRequest
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} |
| Debug Request | Enabling this flag will log out the current request. | false |
| File Data | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] |
| File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | |
| Form Data | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] |
| Header | A list of headers to send with the request. | User-Agent: curl/7.64.1 |
| Max Retry Count | The maximum number of retries to attempt. | 0 |
| Method | The HTTP method to use. | |
| 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. | |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Retry On All Errors | If true, retries on all erroneous responses regardless of type. | false |
| Retry Delay (ms) | The delay in milliseconds between retries. | 0 |
| Timeout | The maximum time that a client will await a response to its request | 2000 |
| URL | Input the path only (/sap/opu/odata/sap/API_CHANGE_RECORD/A_ChangeRecord(guid'01234567-89ab-cdef-0123-456789abcdef')/to_ChangeRecordRefClass?%24inlinecount=allpages&%24top=50), The base URL is already included (https://{company-url}.api.sap.com/s4hanacloud). For example, to connect to https://{company-url}.api.sap.com/s4hanacloud/sap/opu/odata/sap/API_CHANGE_RECORD/A_ChangeRecord(guid'01234567-89ab-cdef-0123-456789abcdef')/to_ChangeRecordRefClass?%24inlinecount=allpages&%24top=50, only /sap/opu/odata/sap/API_CHANGE_RECORD/A_ChangeRecord(guid'01234567-89ab-cdef-0123-456789abcdef')/to_ChangeRecordRefClass?%24inlinecount=allpages&%24top=50 is entered in this field. | /sap/opu/odata/sap/API_CHANGE_RECORD/A_ChangeRecord(guid'01234567-89ab-cdef-0123-456789abcdef')/to_ChangeRecordRefClass?%24inlinecount=allpages&%24top=50 |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. | false |
Raw Request - ODATA
Send an ODATA raw HTTP request to SAP S/4HANA | key: rawRequestOdata
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} |
| Debug Request | Enabling this flag will log out the current request. | false |
| Expand | Expand property to be returned | |
| File Data | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] |
| File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | |
| Filter | Filter items by property values | |
| Form Data | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] |
| Header | A list of headers to send with the request. | User-Agent: curl/7.64.1 |
| Inline Count | ||
| Max Retry Count | The maximum number of retries to attempt. | 0 |
| Method | The HTTP method to use. | |
| Order By | Order by property | |
| 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. | |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Retry On All Errors | If true, retries on all erroneous responses regardless of type. | false |
| Retry Delay (ms) | The delay in milliseconds between retries. | 0 |
| Search | Search items by search phrases | |
| Select | Select property to be returned | |
| Skip | Skip the first n items | |
| Timeout | The maximum time that a client will await a response to its request | 2000 |
| Top | Show only the first n items | |
| URL | Input the path only (/sap/opu/odata/sap/API_CHANGE_RECORD/A_ChangeRecord(guid'01234567-89ab-cdef-0123-456789abcdef')/to_ChangeRecordRefClass?%24inlinecount=allpages&%24top=50), The base URL is already included (https://{company-url}.api.sap.com/s4hanacloud). For example, to connect to https://{company-url}.api.sap.com/s4hanacloud/sap/opu/odata/sap/API_CHANGE_RECORD/A_ChangeRecord(guid'01234567-89ab-cdef-0123-456789abcdef')/to_ChangeRecordRefClass?%24inlinecount=allpages&%24top=50, only /sap/opu/odata/sap/API_CHANGE_RECORD/A_ChangeRecord(guid'01234567-89ab-cdef-0123-456789abcdef')/to_ChangeRecordRefClass?%24inlinecount=allpages&%24top=50 is entered in this field. | /sap/opu/odata/sap/API_CHANGE_RECORD/A_ChangeRecord(guid'01234567-89ab-cdef-0123-456789abcdef')/to_ChangeRecordRefClass?%24inlinecount=allpages&%24top=50 |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. | false |
Update Change Record
Updates header attributes of the change record specified in the request. | key: updateChangeRecord
| Input | Notes | Example |
|---|---|---|
| Change Record UUID | NodeID | |
| Connection | ||
| Body | Request Body |
Update Project
Updates the basic information for a customer or internal project. | key: updateProject
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Project ID | Project ID | |
| Body | Request Body |
Update Purchase Requisition
Updates the header details of a purchase requisition. | key: updatePurchaseRequisition
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Purchase Requisition Number | Purchase Requisition Number | |
| Body | Request Body |
Update Record
Updates an existing record in SAP S/4HANA. | key: updateRecord
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Record ID | ID number tied to the record | 12312313 |
| Record Type | Type of SAP S/4HANA Record, e.g: WorkItemSet | WorkItemSet |
| Body | Request Body |
Update Subscription
Updates business events subscription status using the business event subscriber code, SAP object type, SAP object task code, and business event subscription state code. | key: updateSubscription
| Input | Notes | Example |
|---|---|---|
| Bus Event Subscriber Code | Subscriber ID | |
| Connection | ||
| Body | Request Body | |
| SAP Object Task Code | SAP Object Task Code | |
| SAP Object Type | SAP Object Type |
Update Timesheet Entry Collection
Creates, updates, or deletes workforce timesheet entry based on the data provided in payload. | key: updateTimesheetEntryCollection
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Body | Request Body |