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 Prismatic 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 Prismatic connection. You can also select the API key manually and copy it.

Detailed Info Here

Input	Notes
Input SAP API Key string / Required apiKey	Notes 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
Input Base URL string / Required baseUrl	Notes 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
Input Connection connection / Required connectionInput	Notes
Input Request Body string / Required requestBody	Notes Request Body

---

Add Item To Purchase Requisition

Adds an item to a purchase requisition using the purchase requisition number provided. | key: addItemToPurchaseRequisition

Input	Default	Notes
Input Connection connection / Required connectionInput	Default	Notes
Input Purchase Requisition Number string / Required purchaseRequisitionNumberInput	Default	Notes Purchase Requisition Number
Input Body code / Required requestBodyCode	Default	Notes Request Body

---

Create Change Record

Creates a change record. | key: createChangeRecord

Input	Default	Notes
Input Connection connection / Required connectionInput	Default	Notes
Input Project ID string / Required projectId	Default	Notes Project ID
Input Body code / Required requestBodyCode	Default	Notes Request Body

---

Create Project

Creates a customer or internal project based on the level of information you provide. | key: createProject

Input	Default	Notes
Input Connection connection / Required connectionInput	Default	Notes
Input Body code / Required requestBodyCode	Default	Notes Request Body

---

Create Purchase Requisition

Creates a purchase requisition with one or more items. | key: createPurchaseRequisition

Input	Default	Notes
Input Connection connection / Required connectionInput	Default	Notes
Input Body code / Required requestBodyCode	Default	Notes Request Body

---

Create Record

Creates a new record in SAP S/4HANA. | key: createRecord

Input	Default	Notes
Input Connection connection / Required connectionInput	Default	Notes
Input Record Type string / Required recordType	Default WorkItemSet	Notes Type of SAP S/4HANA Record, e.g: WorkItemSet
Input Body code / Required requestBodyCode	Default	Notes Request Body

---

Create Subscription

Creates business event subscriptions. | key: createSubscription

Input	Default	Notes
Input Connection connection / Required connectionInput	Default	Notes
Input Body code requestBodyCode	Default	Notes 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
Input Archive Document ID string / Required archiveDocumentId	Notes Archive Document ID
Input Business Object Type Name string / Required businessObjectTypeName	Notes Business Object Type Name
Input Connection connection / Required connectionInput	Notes
Input Document Info Record Document Number string / Required documentInfoRecordDocumentNumber	Notes Document Info Record Document Number
Input Document Info Record Document Part string / Required documentInfoRecordDocumentPart	Notes Document Info Record Document Part
Input Document Info Record Document Type string / Required documentInfoRecordDocumentType	Notes Document Info Record Document Type
Input Document Info Record Document Version string / Required documentInfoRecordDocumentVersion	Notes Document Info Record Document Version
Input Linked SAP Object Key string / Required linkedSapObjectKey	Notes Linked SAP Object Key
Input Logical Document string / Required logicalDocument	Notes Logical Document

---

Delete Record

Deletes an existing record in SAP S/4HANA. | key: deleteRecord

Input	Default	Notes
Input Connection connection / Required connectionInput	Default	Notes
Input Record ID string / Required recordId	Default 12312313	Notes ID number tied to the record
Input Record Type string / Required recordType	Default WorkItemSet	Notes Type of SAP S/4HANA Record, e.g: WorkItemSet

---

Get Attachment

Reads the attachments associated with a document info record. | key: getAttachment

Input	Notes
Input Order By string Value List attachOrderBy	Notes Order items by property value
Input Select string Value List attachSelect	Notes Select property to be returned
Input Connection connection / Required connectionInput	Notes
Input Document Info Record Document Number string / Required documentInfoRecordDocumentNumber	Notes Document Info Record Document Number
Input Document Info Record Document Part string / Required documentInfoRecordDocumentPart	Notes Document Info Record Document Part
Input Document Info Record Document Type string / Required documentInfoRecordDocumentType	Notes Document Info Record Document Type
Input Document Info Record Document Version string / Required documentInfoRecordDocumentVersion	Notes Document Info Record Document Version
Input Filter string filter	Notes Filter items by property values
Input Inline Count string inlinecount	Notes

---

Get Change Records

Reads data of a specific change record based on its universally unique identifier (UUID). | key: getChangerecord

Input	Notes
Input Expand string Value List changerecordExpand	Notes Expand property to be returned
Input Select string Value List changerecordSelect	Notes Select property to be returned
Input Change Record UUID string / Required changeRecordUuid	Notes NodeID
Input Connection connection / Required connectionInput	Notes

---

Get Project

Returns details about a customer or internal project. | key: getProject

Input	Notes
Input Connection connection / Required connectionInput	Notes
Input Expand string Value List projectExpand	Notes Expand to include related entities
Input Project ID string / Required projectId	Notes Project ID
Input Select string Value List projectSelect	Notes 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
Input Connection connection / Required connectionInput	Notes
Input Expand string Value List expand	Notes Expand property to be returned
Input Purchase Requisition Number string / Required purchaseRequisitionNumber	Notes Purchase Requisition Number
Input Select string Value List select	Notes 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
Input Connection connection / Required connectionInput	Notes
Input Expand string Value List expand	Notes Expand property to be returned
Input Filter string filter	Notes Filter items by property values
Input Inline Count string inlinecount	Notes
Input Order By string Value List orderBy	Notes Order items by property value
Input Purchase Requisition Number string / Required purchaseRequisitionNumber	Notes Purchase Requisition Number
Input Select string Value List select	Notes Select property to be returned
Input Skip string skip	Notes Skip the first n items
Input Top string top	Notes Show only the first n items

---

Get Record

Retrieve a single record from SAP S/4HANA | key: getRecord

Input	Default	Notes
Input Connection connection / Required connectionInput	Default	Notes
Input Expand string expand	Default	Notes Expand related entities
Input Filter string filter	Default	Notes Filter items by property values
Input Inline Count string inlinecount	Default	Notes
Input Order By string orderBy	Default	Notes Order items by property value
Input Record ID string / Required recordId	Default 12312313	Notes ID number tied to the record
Input Record Type string / Required recordType	Default WorkItemSet	Notes Type of SAP S/4HANA Record, e.g: WorkItemSet
Input Select string select	Default	Notes Select property to be returned
Input Skip string skip	Default	Notes Skip the first n items
Input Top string top	Default	Notes Show only the first n items

---

List Change Records

Retrieves the list of change records in the system. | key: listChangeRecords

Input	Notes
Input Expand string Value List changeRecordExpand	Notes Expand property to be returned
Input Order By string Value List changeRecordOrderBy	Notes Order items by property value
Input Select string Value List changeRecordSelect	Notes Select property to be returned
Input Connection connection / Required connectionInput	Notes
Input Filter string filter	Notes Filter items by property values
Input Inline Count string inlinecount	Notes
Input Skip string skip	Notes Skip the first n items
Input Top string top	Notes Show only the first n items

---

List Files

Retrieves list of prepared files, based on specific filter conditions. | key: listFiles

Input	Notes	Example
Input Connection connection / Required connectionInput	Notes	Example
Input Filter string / Required filter	Notes Filter items by property values	Example
Input Inline Count string inlinecount	Notes	Example
Input Select string Value List select	Notes Select property to be returned	Example 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
Input Connection connection / Required connectionInput	Notes
Input Expand string Value List expand	Notes Expand property to be returned
Input Filter string filter	Notes Filter items by property values
Input Inline Count string inlinecount	Notes
Input Order By string Value List orderBy	Notes Order by property
Input Select string Value List select	Notes Select property to be returned

---

List Purchase Requisitions

Gets the header details of all the purchase requisitions in the system. | key: listPurchaseRequisitions

Input	Notes
Input Connection connection / Required connectionInput	Notes
Input Expand string Value List expand	Notes Expand property to be returned
Input Filter string filter	Notes Filter items by property values
Input Inline Count string inlinecount	Notes
Input Order By string Value List orderBy	Notes Order items by property value
Input Select string Value List select	Notes Select property to be returned
Input Skip string skip	Notes Skip the first n items
Input Top string top	Notes Show only the first n items

---

List Records

Retrieve a list of records from SAP S/4HANA. | key: listRecords

Input	Default	Notes	Example
Input Connection connection / Required connectionInput	Default	Notes	Example
Input Expand string Value List expand	Default	Notes Expand related entities	Example Available values (use one): ProjectRoleSet, WorkPackageSet
Input Filter string filter	Default	Notes Filter items by property values	Example
Input Inline Count string inlinecount	Default	Notes	Example
Input Order By string Value List orderBy	Default	Notes Order items by property value	Example 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
Input Record Type string / Required recordType	Default WorkItemSet	Notes Type of SAP S/4HANA Record, e.g: WorkItemSet	Example
Input Select string Value List select	Default	Notes Select property to be returned	Example 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
Input Skip string skip	Default	Notes Skip the first n items	Example
Input Top string top	Default	Notes Show only the first n items	Example

---

List Subscriptions

Reads subscription information for business events. | key: listSubscriptions

Input	Notes
Input Connection connection / Required connectionInput	Notes
Input Filter string filter	Notes Filter items by property values
Input Inline Count string inlinecount	Notes
Input Order By string Value List orderBy	Notes Order by property
Input Search string search	Notes Search items by search phrases
Input Select string Value List select	Notes Select property to be returned
Input Skip string skip	Notes Skip the first n items
Input Top string top	Notes 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
Input Connection connection / Required connectionInput	Notes
Input Filter string filter	Notes Filter items by property values
Input Inline Count string inlinecount	Notes
Input Order By string Value List orderBy	Notes Order by property
Input Select string Value List select	Notes Select property to be returned
Input Skip string skip	Notes Skip the first n items
Input Top string top	Notes Show only the first n items

---

Raw Request

Send raw HTTP request to SAP S/4HANA | key: rawRequest

Input	Default	Notes	Example
Input Connection connection / Required connection	Default	Notes	Example
Input Data string data	Default	Notes The HTTP body payload to send to the URL.	Example {"exampleKey": "Example Data"}
Input Debug Request boolean debugRequest	Default false	Notes Enabling this flag will log out the current request.	Example
Input File Data string Key Value List fileData	Default	Notes File Data to be sent as a multipart form upload.	Example [{key: "example.txt", value: "My File Contents"}]
Input File Data File Names string Key Value List fileDataFileNames	Default	Notes File names to apply to the file data inputs. Keys must match the file data keys above.	Example
Input Form Data string Key Value List formData	Default	Notes The Form Data to be sent as a multipart form upload.	Example [{"key": "Example Key", "value": new Buffer("Hello World")}]
Input Header string Key Value List headers	Default	Notes A list of headers to send with the request.	Example User-Agent: curl/7.64.1
Input Max Retry Count string maxRetries	Default 0	Notes The maximum number of retries to attempt.	Example
Input Method string / Required method	Default	Notes The HTTP method to use.	Example
Input Query Parameter string Key Value List queryParams	Default	Notes 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.	Example
Input Response Type string / Required responseType	Default json	Notes The type of data you expect in the response. You can request json, text, or binary data.	Example
Input Retry On All Errors boolean retryAllErrors	Default false	Notes If true, retries on all erroneous responses regardless of type.	Example
Input Retry Delay (ms) string retryDelayMS	Default 0	Notes The delay in milliseconds between retries.	Example
Input Timeout string timeout	Default	Notes The maximum time that a client will await a response to its request	Example 2000
Input URL string / Required url	Default	Notes 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.	Example /sap/opu/odata/sap/API_CHANGE_RECORD/A_ChangeRecord(guid'01234567-89ab-cdef-0123-456789abcdef')/to_ChangeRecordRefClass?%24inlinecount=allpages&%24top=50
Input Use Exponential Backoff boolean useExponentialBackoff	Default false	Notes Specifies whether to use a pre-defined exponential backoff strategy for retries.	Example

---

Raw Request - ODATA

Send an ODATA raw HTTP request to SAP S/4HANA | key: rawRequestOdata

Input	Default	Notes	Example
Input Connection connection / Required connection	Default	Notes	Example
Input Data string data	Default	Notes The HTTP body payload to send to the URL.	Example {"exampleKey": "Example Data"}
Input Debug Request boolean debugRequest	Default false	Notes Enabling this flag will log out the current request.	Example
Input Expand string Value List expand	Default	Notes Expand property to be returned	Example
Input File Data string Key Value List fileData	Default	Notes File Data to be sent as a multipart form upload.	Example [{key: "example.txt", value: "My File Contents"}]
Input File Data File Names string Key Value List fileDataFileNames	Default	Notes File names to apply to the file data inputs. Keys must match the file data keys above.	Example
Input Filter string filter	Default	Notes Filter items by property values	Example
Input Form Data string Key Value List formData	Default	Notes The Form Data to be sent as a multipart form upload.	Example [{"key": "Example Key", "value": new Buffer("Hello World")}]
Input Header string Key Value List headers	Default	Notes A list of headers to send with the request.	Example User-Agent: curl/7.64.1
Input Inline Count string inlinecount	Default	Notes	Example
Input Max Retry Count string maxRetries	Default 0	Notes The maximum number of retries to attempt.	Example
Input Method string / Required method	Default	Notes The HTTP method to use.	Example
Input Order By string Value List orderBy	Default	Notes Order by property	Example
Input Query Parameter string Key Value List queryParams	Default	Notes 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.	Example
Input Response Type string / Required responseType	Default json	Notes The type of data you expect in the response. You can request json, text, or binary data.	Example
Input Retry On All Errors boolean retryAllErrors	Default false	Notes If true, retries on all erroneous responses regardless of type.	Example
Input Retry Delay (ms) string retryDelayMS	Default 0	Notes The delay in milliseconds between retries.	Example
Input Search string search	Default	Notes Search items by search phrases	Example
Input Select string Value List select	Default	Notes Select property to be returned	Example
Input Skip string skip	Default	Notes Skip the first n items	Example
Input Timeout string timeout	Default	Notes The maximum time that a client will await a response to its request	Example 2000
Input Top string top	Default	Notes Show only the first n items	Example
Input URL string / Required url	Default	Notes 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.	Example /sap/opu/odata/sap/API_CHANGE_RECORD/A_ChangeRecord(guid'01234567-89ab-cdef-0123-456789abcdef')/to_ChangeRecordRefClass?%24inlinecount=allpages&%24top=50
Input Use Exponential Backoff boolean useExponentialBackoff	Default false	Notes Specifies whether to use a pre-defined exponential backoff strategy for retries.	Example

---

Update Change Record

Updates header attributes of the change record specified in the request. | key: updateChangeRecord

Input	Default	Notes
Input Change Record UUID string / Required changeRecordUuid	Default	Notes NodeID
Input Connection connection / Required connectionInput	Default	Notes
Input Body code / Required requestBodyCode	Default	Notes Request Body

---

Update Project

Updates the basic information for a customer or internal project. | key: updateProject

Input	Default	Notes
Input Connection connection / Required connectionInput	Default	Notes
Input Project ID string / Required projectId	Default	Notes Project ID
Input Body code / Required requestBodyCode	Default	Notes Request Body

---

Update Purchase Requisition

Updates the header details of a purchase requisition. | key: updatePurchaseRequisition

Input	Default	Notes
Input Connection connection / Required connectionInput	Default	Notes
Input Purchase Requisition Number string / Required purchaseRequisitionNumberInput	Default	Notes Purchase Requisition Number
Input Body code / Required requestBodyCode	Default	Notes Request Body

---

Update Record

Updates an existing record in SAP S/4HANA. | key: updateRecord

Input	Default	Notes	Example
Input Connection connection / Required connectionInput	Default	Notes	Example
Input Record ID string / Required recordId	Default 12312313	Notes ID number tied to the record	Example
Input Record Type string / Required recordType	Default WorkItemSet	Notes Type of SAP S/4HANA Record, e.g: WorkItemSet	Example
Input Body code / Required requestBodyCode	Default	Notes Request Body	Example

---

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	Default	Notes
Input Bus Event Subscriber Code string / Required busEventSubscriberCode	Default	Notes Subscriber ID
Input Connection connection / Required connectionInput	Default	Notes
Input Body code / Required requestBodyCode	Default	Notes Request Body
Input SAP Object Task Code string / Required sapObjectTaskCode	Default	Notes SAP Object Task Code
Input SAP Object Type string / Required sapObjectType	Default	Notes SAP Object Type

---

Update Timesheet Entry Collection

Creates, updates, or deletes workforce timesheet entry based on the data provided in payload. | key: updateTimesheetEntryCollection

Input	Default	Notes
Input Connection connection / Required connectionInput	Default	Notes
Input Body code / Required requestBodyCode	Default	Notes Request Body

---