SAP S/4HANA Cloud Connector

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)

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.

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

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.

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_0008 for 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

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.

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_0008 for 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., my123456 from my123456.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

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

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:

SAP Help: Communication Management

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

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

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

Creates a change record.

Input Comments Default

Body

Request Body

Input	Comments	Default
Body	Request Body	{ "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecord": "string", "ChangeRecordType": "string", "ChangeRecordStatus": "string", "ChangeNumber": "string", "ChangeRecordLifecycleStatus": "string", "Partner": "string", "ChgRecordDescriptionText": "string", "ChangeRecordDetailDescription": "string", "ChgRecdExpectedCompletionDate": "/Date(1492041600000)/", "to_ChangeRecordFuncLocTskList": { "results": [ { "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecord": "string", "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecordReferenceType": "string", "FuncLocTskListGroup": "string", "FuncLocTskList": "string", "ChangeRecordItemRelevance": "string", "ChangeRecordItemProcgStatus": "string" } ] }, "to_ChangeRecordRefCharc": { "results": [ { "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecord": "string", "Characteristic": "string", "ChangeNumber": "string", "CharcDataType": "string", "CharcStatus": "string", "ValidityStartDate": "/Date(1492041600000)/", "CharcInternalID": "string", "CharcDecimals": 0, "CharcLength": 0, "CharcValueUnit": "string", "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecordReferenceType": "string", "ChangeRecordReferenceSubtype": "string", "ChangeRecordReference": "string", "ParentChangeRecordRefUUID": "01234567-89ab-cdef-0123-456789abcdef", "IsMainReference": "string", "CreationDate": "/Date(1492041600000)/", "LastChangeDate": "/Date(1492041600000)/", "ChangeRecordItemRelevance": "string", "ChangeRecordVirtualRefInd": "string", "ChangeRecordRefObjectUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecordItemProcgStatus": "string" } ] }, "to_ChangeRecordRefClass": { "results": [ { "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecord": "string", "Class": "string", "ClassType": "string", "ChangeNumber": "string", "ClassName": "string", "ClassTypeName": "string", "ValidityStartDate": "/Date(1492041600000)/", "ClassStatus": "string", "ClassStatusName": "string", "ClassInternalID": "string", "ChangeRecordItemProcgStatus": "string", "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecordReferenceType": "string", "ChangeRecordReferenceSubtype": "string", "ParentChangeRecordRefUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecordItemRelevance": "string", "ChangeRecordReference": "string", "ChangeRecordStatus": "string", "CreationDate": "/Date(1492041600000)/", "LastChangeDate": "/Date(1492041600000)/", "ChangeRecordVirtualRefInd": "string" } ] }, "to_ChangeRecordRefEquipTskList": { "results": [ { "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecord": "string", "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecordReferenceType": "string", "EquipmentTskListGroup": "string", "EquipmentTskList": "string", "ChangeRecordItemRelevance": "string", "ChangeRecordItemProcgStatus": "string" } ] }, "to_ChangeRecordRefMasterRecipe": { "results": [ { "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecord": "string", "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecordReferenceType": "string", "MasterRecipeGroup": "string", "MasterRecipe": "string", "ChangeRecordItemProcgStatus": "string", "ChangeRecordItemRelevance": "string" } ] }, "to_ChangeRecordRefProdnRouting": { "results": [ { "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecord": "string", "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecordReferenceType": "string", "BillOfOperationsGroup": "string", "BillOfOperationsVariant": "string", "ChangeRecordItemRelevance": "string", "ChangeRecordItemProcgStatus": "string" } ] }, "to_ChangeRecordRefStdBOM": { "results": [ { "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef", "StandardObject": "string", "Plant": "string", "BillOfMaterialVariantUsage": "string", "BillOfMaterialVariant": "string", "ChangeRecord": "string", "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeNumber": "string", "ChangeRecordItemRelevance": "string", "ChangeRecordItemProcgStatus": "string" } ] }, "to_ChangeRecordRefVarBOM": { "results": [ { "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecord": "string", "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecordReferenceType": "string", "ChangeRecordReferenceSubtype": "string", "ChangeRecordReference": "string", "ParentChangeRecordRefUUID": "01234567-89ab-cdef-0123-456789abcdef", "IsMainReference": "string", "BillOfMaterialCategory": "string", "ChangeNumber": "string", "ChangeRecordVirtualRefInd": "string", "BillOfMaterial": "string", "Material": "string", "Plant": "string", "BillOfMaterialVariantUsage": "string", "BillOfMaterialVariant": "string", "ChangeRecordItemRelevance": "string", "ChangeRecordItemProcgStatus": "string" } ] }, "to_ChgRecdCollaboration": { "results": [ { "ChgRecdPLMEPDCollabnUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChgRecdPLMEPDCollabnType": "string", "CreatedByUser": "string", "CreationDateTime": "/Date(1492098664000)/", "ChgRecdPLMEPDCollabnSourceID": "string", "ChgRecdPLMEPDCollabnID": "string" } ] }, "to_ChgRecdEquipBOM": { "results": [ { "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecord": "string", "Equipment": "string", "Plant": "string", "BillOfMaterialVariantUsage": "string", "BillOfMaterialVariant": "string", "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecordReferenceType": "string", "ChangeRecordReferenceSubtype": "string", "ChangeRecordReference": "string", "ParentChangeRecordRefUUID": "01234567-89ab-cdef-0123-456789abcdef", "IsMainReference": "string", "BillOfMaterialCategory": "string", "ChangeNumber": "string", "ChangeRecordItemRelevance": "string", "ChangeRecordVirtualRefInd": "string", "BillOfMaterial": "string", "ChangeRecordRefObjectUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecordItemProcgStatus": "string" } ] }, "to_ChgRecdFuncLocBOM": { "results": [ { "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecord": "string", "FunctionalLocation": "string", "Plant": "string", "BillOfMaterialVariantUsage": "string", "BillOfMaterialVariant": "string", "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecordReferenceType": "string", "ChangeRecordReferenceSubtype": "string", "ChangeRecordReference": "string", "ParentChangeRecordRefUUID": "01234567-89ab-cdef-0123-456789abcdef", "IsMainReference": "string", "BillOfMaterialCategory": "string", "ChangeNumber": "string", "ChangeRecordItemRelevance": "string", "ChangeRecordVirtualRefInd": "string", "BillOfMaterial": "string", "ChangeRecordRefObjectUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecordItemProcgStatus": "string" } ] }, "to_ChgRecdRefEngBOM": { "results": [ { "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef", "Material": "string", "Plant": "string", "BillOfMaterialVariantUsage": "string", "BillOfMaterialVariant": "string", "BillOfMaterial": "string", "BillOfMaterialCategory": "string", "BillOfMaterialVersion": "string", "ChangeRecord": "string", "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecordReferenceType": "string", "ChangeRecordReferenceSubtype": "string", "ChangeRecordRefObjectUUID": "01234567-89ab-cdef-0123-456789abcdef", "ParentChangeRecordRefUUID": "01234567-89ab-cdef-0123-456789abcdef", "IsMainReference": "string", "ChangeRecordVirtualRefInd": "string", "ChangeRecordItemRelevance": "string", "ChangeRecordItemProcgStatus": "string" } ] }, "to_ChgRecdRefMaintTskList": { "results": [ { "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecord": "string", "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef", "RefMaintTskListGroup": "string", "RefMaintTskList": "string", "ChangeRecordItemRelevance": "string", "ChangeRecordItemProcgStatus": "string" } ] }, "to_ChgRecdRefMfgBOM": { "results": [ { "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef", "Material": "string", "Plant": "string", "BillOfMaterialVariantUsage": "string", "BillOfMaterialVariant": "string", "BillOfMaterial": "string", "BillOfMaterialCategory": "string", "BillOfMaterialVersion": "string", "ChangeRecord": "string", "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecordReferenceType": "string", "ChangeRecordReferenceSubtype": "string", "ChangeRecordRefObjectUUID": "01234567-89ab-cdef-0123-456789abcdef", "ParentChangeRecordRefUUID": "01234567-89ab-cdef-0123-456789abcdef", "IsMainReference": "string", "ChangeRecordVirtualRefInd": "string", "ChangeRecordItemRelevance": "string", "ChangeRecordItemProcgStatus": "string" } ] }, "to_RefBit": { "results": [ { "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecord": "string", "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecordReferenceType": "string", "BillOfMaterialItemNumber": "string", "BillOfMaterialComponent": "string", "Material": "string", "Plant": "string", "BillOfMaterialVariantUsage": "string", "BillOfMaterialVariant": "string", "ChangeRecordItemRelevance": "string" } ] }, "to_RefBOM": { "results": [ { "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecord": "string", "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecordReferenceType": "string", "Material": "string", "Plant": "string", "BillOfMaterialVariantUsage": "string", "BillOfMaterialVariant": "string", "ChangeRecordItemRelevance": "string", "ChangeRecordItemProcgStatus": "string" } ] }, "to_RefDoc": { "results": [ { "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecord": "string", "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecordReferenceType": "string", "DocumentInfoRecord": "string", "DocumentType": "string", "DocumentPart": "string", "DocumentVersion": "string", "ChangeRecordItemRelevance": "string", "ExternalDocumentStatus": "string" } ] }, "to_RefMat": { "results": [ { "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecord": "string", "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecordReferenceType": "string", "Material": "string", "MaterialType": "string", "BaseUnit": "string", "MaterialStatus": "string", "ChangeRecordItemRelevance": "string", "ChangeRecordItemProcgStatus": "string" } ] }, "to_RefPSV": { "results": [ { "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef", "ChangeRecord": "string", "ChangeRecordReferenceType": "string", "Material": "string", "Class": "string", "ProductStructureNodeName": "string", "ProdStrucNodeDescription": "string", "ProductStructureVariantName": "string", "ProdStrucVariantDescription": "string", "ProdStrucVariantChangeNumber": "string", "ChangeRecordItemRelevance": "string", "ChangeRecordRefObjectUUID": "01234567-89ab-cdef-0123-456789abcdef" } ] } }
Connection
Project ID	Project ID

{
 "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecord": "string",
 "ChangeRecordType": "string",
 "ChangeRecordStatus": "string",
 "ChangeNumber": "string",
 "ChangeRecordLifecycleStatus": "string",
 "Partner": "string",
 "ChgRecordDescriptionText": "string",
 "ChangeRecordDetailDescription": "string",
 "ChgRecdExpectedCompletionDate": "/Date(1492041600000)/",
 "to_ChangeRecordFuncLocTskList": {
 "results": [
 {
 "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecord": "string",
 "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecordReferenceType": "string",
 "FuncLocTskListGroup": "string",
 "FuncLocTskList": "string",
 "ChangeRecordItemRelevance": "string",
 "ChangeRecordItemProcgStatus": "string"
 }
 ]
 },
 "to_ChangeRecordRefCharc": {
 "results": [
 {
 "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecord": "string",
 "Characteristic": "string",
 "ChangeNumber": "string",
 "CharcDataType": "string",
 "CharcStatus": "string",
 "ValidityStartDate": "/Date(1492041600000)/",
 "CharcInternalID": "string",
 "CharcDecimals": 0,
 "CharcLength": 0,
 "CharcValueUnit": "string",
 "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecordReferenceType": "string",
 "ChangeRecordReferenceSubtype": "string",
 "ChangeRecordReference": "string",
 "ParentChangeRecordRefUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "IsMainReference": "string",
 "CreationDate": "/Date(1492041600000)/",
 "LastChangeDate": "/Date(1492041600000)/",
 "ChangeRecordItemRelevance": "string",
 "ChangeRecordVirtualRefInd": "string",
 "ChangeRecordRefObjectUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecordItemProcgStatus": "string"
 }
 ]
 },
 "to_ChangeRecordRefClass": {
 "results": [
 {
 "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecord": "string",
 "Class": "string",
 "ClassType": "string",
 "ChangeNumber": "string",
 "ClassName": "string",
 "ClassTypeName": "string",
 "ValidityStartDate": "/Date(1492041600000)/",
 "ClassStatus": "string",
 "ClassStatusName": "string",
 "ClassInternalID": "string",
 "ChangeRecordItemProcgStatus": "string",
 "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecordReferenceType": "string",
 "ChangeRecordReferenceSubtype": "string",
 "ParentChangeRecordRefUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecordItemRelevance": "string",
 "ChangeRecordReference": "string",
 "ChangeRecordStatus": "string",
 "CreationDate": "/Date(1492041600000)/",
 "LastChangeDate": "/Date(1492041600000)/",
 "ChangeRecordVirtualRefInd": "string"
 }
 ]
 },
 "to_ChangeRecordRefEquipTskList": {
 "results": [
 {
 "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecord": "string",
 "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecordReferenceType": "string",
 "EquipmentTskListGroup": "string",
 "EquipmentTskList": "string",
 "ChangeRecordItemRelevance": "string",
 "ChangeRecordItemProcgStatus": "string"
 }
 ]
 },
 "to_ChangeRecordRefMasterRecipe": {
 "results": [
 {
 "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecord": "string",
 "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecordReferenceType": "string",
 "MasterRecipeGroup": "string",
 "MasterRecipe": "string",
 "ChangeRecordItemProcgStatus": "string",
 "ChangeRecordItemRelevance": "string"
 }
 ]
 },
 "to_ChangeRecordRefProdnRouting": {
 "results": [
 {
 "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecord": "string",
 "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecordReferenceType": "string",
 "BillOfOperationsGroup": "string",
 "BillOfOperationsVariant": "string",
 "ChangeRecordItemRelevance": "string",
 "ChangeRecordItemProcgStatus": "string"
 }
 ]
 },
 "to_ChangeRecordRefStdBOM": {
 "results": [
 {
 "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "StandardObject": "string",
 "Plant": "string",
 "BillOfMaterialVariantUsage": "string",
 "BillOfMaterialVariant": "string",
 "ChangeRecord": "string",
 "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeNumber": "string",
 "ChangeRecordItemRelevance": "string",
 "ChangeRecordItemProcgStatus": "string"
 }
 ]
 },
 "to_ChangeRecordRefVarBOM": {
 "results": [
 {
 "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecord": "string",
 "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecordReferenceType": "string",
 "ChangeRecordReferenceSubtype": "string",
 "ChangeRecordReference": "string",
 "ParentChangeRecordRefUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "IsMainReference": "string",
 "BillOfMaterialCategory": "string",
 "ChangeNumber": "string",
 "ChangeRecordVirtualRefInd": "string",
 "BillOfMaterial": "string",
 "Material": "string",
 "Plant": "string",
 "BillOfMaterialVariantUsage": "string",
 "BillOfMaterialVariant": "string",
 "ChangeRecordItemRelevance": "string",
 "ChangeRecordItemProcgStatus": "string"
 }
 ]
 },
 "to_ChgRecdCollaboration": {
 "results": [
 {
 "ChgRecdPLMEPDCollabnUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChgRecdPLMEPDCollabnType": "string",
 "CreatedByUser": "string",
 "CreationDateTime": "/Date(1492098664000)/",
 "ChgRecdPLMEPDCollabnSourceID": "string",
 "ChgRecdPLMEPDCollabnID": "string"
 }
 ]
 },
 "to_ChgRecdEquipBOM": {
 "results": [
 {
 "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecord": "string",
 "Equipment": "string",
 "Plant": "string",
 "BillOfMaterialVariantUsage": "string",
 "BillOfMaterialVariant": "string",
 "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecordReferenceType": "string",
 "ChangeRecordReferenceSubtype": "string",
 "ChangeRecordReference": "string",
 "ParentChangeRecordRefUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "IsMainReference": "string",
 "BillOfMaterialCategory": "string",
 "ChangeNumber": "string",
 "ChangeRecordItemRelevance": "string",
 "ChangeRecordVirtualRefInd": "string",
 "BillOfMaterial": "string",
 "ChangeRecordRefObjectUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecordItemProcgStatus": "string"
 }
 ]
 },
 "to_ChgRecdFuncLocBOM": {
 "results": [
 {
 "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecord": "string",
 "FunctionalLocation": "string",
 "Plant": "string",
 "BillOfMaterialVariantUsage": "string",
 "BillOfMaterialVariant": "string",
 "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecordReferenceType": "string",
 "ChangeRecordReferenceSubtype": "string",
 "ChangeRecordReference": "string",
 "ParentChangeRecordRefUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "IsMainReference": "string",
 "BillOfMaterialCategory": "string",
 "ChangeNumber": "string",
 "ChangeRecordItemRelevance": "string",
 "ChangeRecordVirtualRefInd": "string",
 "BillOfMaterial": "string",
 "ChangeRecordRefObjectUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecordItemProcgStatus": "string"
 }
 ]
 },
 "to_ChgRecdRefEngBOM": {
 "results": [
 {
 "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "Material": "string",
 "Plant": "string",
 "BillOfMaterialVariantUsage": "string",
 "BillOfMaterialVariant": "string",
 "BillOfMaterial": "string",
 "BillOfMaterialCategory": "string",
 "BillOfMaterialVersion": "string",
 "ChangeRecord": "string",
 "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecordReferenceType": "string",
 "ChangeRecordReferenceSubtype": "string",
 "ChangeRecordRefObjectUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ParentChangeRecordRefUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "IsMainReference": "string",
 "ChangeRecordVirtualRefInd": "string",
 "ChangeRecordItemRelevance": "string",
 "ChangeRecordItemProcgStatus": "string"
 }
 ]
 },
 "to_ChgRecdRefMaintTskList": {
 "results": [
 {
 "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecord": "string",
 "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "RefMaintTskListGroup": "string",
 "RefMaintTskList": "string",
 "ChangeRecordItemRelevance": "string",
 "ChangeRecordItemProcgStatus": "string"
 }
 ]
 },
 "to_ChgRecdRefMfgBOM": {
 "results": [
 {
 "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "Material": "string",
 "Plant": "string",
 "BillOfMaterialVariantUsage": "string",
 "BillOfMaterialVariant": "string",
 "BillOfMaterial": "string",
 "BillOfMaterialCategory": "string",
 "BillOfMaterialVersion": "string",
 "ChangeRecord": "string",
 "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecordReferenceType": "string",
 "ChangeRecordReferenceSubtype": "string",
 "ChangeRecordRefObjectUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ParentChangeRecordRefUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "IsMainReference": "string",
 "ChangeRecordVirtualRefInd": "string",
 "ChangeRecordItemRelevance": "string",
 "ChangeRecordItemProcgStatus": "string"
 }
 ]
 },
 "to_RefBit": {
 "results": [
 {
 "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecord": "string",
 "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecordReferenceType": "string",
 "BillOfMaterialItemNumber": "string",
 "BillOfMaterialComponent": "string",
 "Material": "string",
 "Plant": "string",
 "BillOfMaterialVariantUsage": "string",
 "BillOfMaterialVariant": "string",
 "ChangeRecordItemRelevance": "string"
 }
 ]
 },
 "to_RefBOM": {
 "results": [
 {
 "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecord": "string",
 "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecordReferenceType": "string",
 "Material": "string",
 "Plant": "string",
 "BillOfMaterialVariantUsage": "string",
 "BillOfMaterialVariant": "string",
 "ChangeRecordItemRelevance": "string",
 "ChangeRecordItemProcgStatus": "string"
 }
 ]
 },
 "to_RefDoc": {
 "results": [
 {
 "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecord": "string",
 "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecordReferenceType": "string",
 "DocumentInfoRecord": "string",
 "DocumentType": "string",
 "DocumentPart": "string",
 "DocumentVersion": "string",
 "ChangeRecordItemRelevance": "string",
 "ExternalDocumentStatus": "string"
 }
 ]
 },
 "to_RefMat": {
 "results": [
 {
 "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecord": "string",
 "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecordReferenceType": "string",
 "Material": "string",
 "MaterialType": "string",
 "BaseUnit": "string",
 "MaterialStatus": "string",
 "ChangeRecordItemRelevance": "string",
 "ChangeRecordItemProcgStatus": "string"
 }
 ]
 },
 "to_RefPSV": {
 "results": [
 {
 "ChangeRecordReferenceUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecordUUID": "01234567-89ab-cdef-0123-456789abcdef",
 "ChangeRecord": "string",
 "ChangeRecordReferenceType": "string",
 "Material": "string",
 "Class": "string",
 "ProductStructureNodeName": "string",
 "ProdStrucNodeDescription": "string",
 "ProductStructureVariantName": "string",
 "ProdStrucVariantDescription": "string",
 "ProdStrucVariantChangeNumber": "string",
 "ChangeRecordItemRelevance": "string",
 "ChangeRecordRefObjectUUID": "01234567-89ab-cdef-0123-456789abcdef"
 }
 ]
 }
 }

Connection

Project ID Project ID

Create Project

Creates a customer or internal project based on the level of information you provide.

Input Comments Default

Body

Request Body

Input	Comments	Default
Body	Request Body	{ "ProjectID": "string", "ProjectName": "string", "ProjectStage": "string", "OrgID": "string", "ProjectCategory": "string", "Currency": "string", "StartDate": "/Date(1492098664000)/", "EndDate": "/Date(1492098664000)/", "ProjManagerExtId": "string", "ProjManagerCompCode": "string", "Customer": "string", "CostCenter": "string", "ProfitCenter": "string", "ProjAccountantExtId": "string", "ProjAccountantCompCode": "string", "ProjControllerExtId": "string", "ProjControllerCompCode": "string", "ProjPartnerExtId": "string", "ProjPartnerCompCode": "string", "ProjectDesc": "string", "Confidential": "string", "UseProjectBilling": "string", "RestrictTimePosting": "string", "ProjectRoleSet": { "results": [ { "ProjectID": "string", "ProjectRoleID": "string", "BusinessPartnerID": "string" } ] }, "WorkPackageSet": { "results": [ { "ProjectID": "string", "WorkPackageID": "string", "WorkPackageName": "string", "Description": "string", "WPStartDate": "/Date(1492098664000)/", "WPEndDate": "/Date(1492098664000)/", "WorkPackageType": "string", "UnitQuantity": "0", "UnitId": "string", "to_ResourceDemand": { "results": [ { "WorkPackage": "string", "ResourceDemand": "string", "Version": "string", "EngagementProject": "string", "WorkItem": "string", "BillingControlCategory": "string", "DeliveryOrganization": "string", "EngagementProjectResourceType": "string", "EngagementProjectResource": "string", "WorkforcePersonUserID": "string", "Country2DigitISOCode": "string", "KeyDate": "/Date(1492041600000)/", "PersonWorkAgreement": "string", "ResourceDemandStatus": "string", "UnitOfMeasure": "string", "Quantity": "0", "to_ResourceDemandDistribution": { "results": [ { "WorkPackage": "string", "ResourceDemand": "string", "Version": "string", "CalendarMonth": "string", "CalendarYear": "string", "UnitOfMeasure": "string", "Quantity": "0", "to_ResourceDemand": null } ] }, "to_ResourceDemandSkills": "", "to_ResourceSupply": { "results": [ { "WorkPackage": "string", "ResourceDemand": "string", "ResourceSupply": "string", "Version": "string", "EngagementProject": "string", "DeliveryOrganization": "string", "WorkforcePersonUserID": "string", "Country2DigitISOCode": "string", "KeyDate": "/Date(1492041600000)/", "PersonWorkAgreement": "string", "UnitOfMeasure": "string", "Quantity": "0", "to_ResourceDemand": null, "to_ResourceSupplyDistribution": { "results": [ { "WorkPackage": "string", "ResourceDemand": "string", "ResourceSupply": "string", "Version": "string", "CalendarMonth": "string", "CalendarYear": "string", "UnitOfMeasure": "string", "Quantity": "0", "to_ResourceSupply": "" } ] } } ] } } ] }, "to_Project": null, "WorkItemSet": { "results": [ { "ProjectID": "string", "WorkPackageID": "string", "WorkPackageName": "string", "Workitem": "string", "Workitemname": "string" } ] }, "DemandSet": { "results": [ { "BillingControlCategory": "string", "ProjectID": "string", "Skills": "string", "WorkPackageID": "string", "ExpenseCost": "0", "WorkPackageName": "string", "ExpenseRevenue": "0", "ResType": "string", "ResourceId": "string", "Workitem": "string", "Effort": "0", "DelvryServOrg": "string" } ] }, "WorkPackageFunctionSet": { "results": [ { "ProjectID": "string", "WorkPackageID": "string", "WorkPackageName": "string", "WorkPackageFunctionId": "string", "WorkPackageFunctionIsBlocked": "string" } ] } } ] } }
Connection

{
 "ProjectID": "string",
 "ProjectName": "string",
 "ProjectStage": "string",
 "OrgID": "string",
 "ProjectCategory": "string",
 "Currency": "string",
 "StartDate": "/Date(1492098664000)/",
 "EndDate": "/Date(1492098664000)/",
 "ProjManagerExtId": "string",
 "ProjManagerCompCode": "string",
 "Customer": "string",
 "CostCenter": "string",
 "ProfitCenter": "string",
 "ProjAccountantExtId": "string",
 "ProjAccountantCompCode": "string",
 "ProjControllerExtId": "string",
 "ProjControllerCompCode": "string",
 "ProjPartnerExtId": "string",
 "ProjPartnerCompCode": "string",
 "ProjectDesc": "string",
 "Confidential": "string",
 "UseProjectBilling": "string",
 "RestrictTimePosting": "string",
 "ProjectRoleSet": {
 "results": [
 {
 "ProjectID": "string",
 "ProjectRoleID": "string",
 "BusinessPartnerID": "string"
 }
 ]
 },
 "WorkPackageSet": {
 "results": [
 {
 "ProjectID": "string",
 "WorkPackageID": "string",
 "WorkPackageName": "string",
 "Description": "string",
 "WPStartDate": "/Date(1492098664000)/",
 "WPEndDate": "/Date(1492098664000)/",
 "WorkPackageType": "string",
 "UnitQuantity": "0",
 "UnitId": "string",
 "to_ResourceDemand": {
 "results": [
 {
 "WorkPackage": "string",
 "ResourceDemand": "string",
 "Version": "string",
 "EngagementProject": "string",
 "WorkItem": "string",
 "BillingControlCategory": "string",
 "DeliveryOrganization": "string",
 "EngagementProjectResourceType": "string",
 "EngagementProjectResource": "string",
 "WorkforcePersonUserID": "string",
 "Country2DigitISOCode": "string",
 "KeyDate": "/Date(1492041600000)/",
 "PersonWorkAgreement": "string",
 "ResourceDemandStatus": "string",
 "UnitOfMeasure": "string",
 "Quantity": "0",
 "to_ResourceDemandDistribution": {
 "results": [
 {
 "WorkPackage": "string",
 "ResourceDemand": "string",
 "Version": "string",
 "CalendarMonth": "string",
 "CalendarYear": "string",
 "UnitOfMeasure": "string",
 "Quantity": "0",
 "to_ResourceDemand": null
 }
 ]
 },
 "to_ResourceDemandSkills": "",
 "to_ResourceSupply": {
 "results": [
 {
 "WorkPackage": "string",
 "ResourceDemand": "string",
 "ResourceSupply": "string",
 "Version": "string",
 "EngagementProject": "string",
 "DeliveryOrganization": "string",
 "WorkforcePersonUserID": "string",
 "Country2DigitISOCode": "string",
 "KeyDate": "/Date(1492041600000)/",
 "PersonWorkAgreement": "string",
 "UnitOfMeasure": "string",
 "Quantity": "0",
 "to_ResourceDemand": null,
 "to_ResourceSupplyDistribution": {
 "results": [
 {
 "WorkPackage": "string",
 "ResourceDemand": "string",
 "ResourceSupply": "string",
 "Version": "string",
 "CalendarMonth": "string",
 "CalendarYear": "string",
 "UnitOfMeasure": "string",
 "Quantity": "0",
 "to_ResourceSupply": ""
 }
 ]
 }
 }
 ]
 }
 }
 ]
 },
 "to_Project": null,
 "WorkItemSet": {
 "results": [
 {
 "ProjectID": "string",
 "WorkPackageID": "string",
 "WorkPackageName": "string",
 "Workitem": "string",
 "Workitemname": "string"
 }
 ]
 },
 "DemandSet": {
 "results": [
 {
 "BillingControlCategory": "string",
 "ProjectID": "string",
 "Skills": "string",
 "WorkPackageID": "string",
 "ExpenseCost": "0",
 "WorkPackageName": "string",
 "ExpenseRevenue": "0",
 "ResType": "string",
 "ResourceId": "string",
 "Workitem": "string",
 "Effort": "0",
 "DelvryServOrg": "string"
 }
 ]
 },
 "WorkPackageFunctionSet": {
 "results": [
 {
 "ProjectID": "string",
 "WorkPackageID": "string",
 "WorkPackageName": "string",
 "WorkPackageFunctionId": "string",
 "WorkPackageFunctionIsBlocked": "string"
 }
 ]
 }
 }
 ]
 }
 }

Connection

Create Purchase Requisition

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

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	`{ "BusEventSubscriberCode": "string", "SAPObjectType": "string", "SAPObjectTaskCode": "string", "BusEventSubscriptionStateCode": "string", "BusEventPriority": 0 }`

Create Subscription

Creates business event subscriptions.

Input	Comments	Default
Body	Request Body	`{ "BusEventSubscriberCode": "string", "SAPObjectType": "string", "SAPObjectTaskCode": "string", "BusEventSubscriptionStateCode": "string", "BusEventPriority": 0 }`
Connection

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Updates header attributes of the change record specified in the request.

Input Comments Default

Body

Request Body

Input	Comments	Default
Body	Request Body	`{ "d": { "ChangeRecord": "string", "ChangeRecordType": "string", "ChangeRecordStatus": "string", "ChangeNumber": "string", "ChangeRecordLifecycleStatus": "string", "Partner": "string", "ChgRecordDescriptionText": "string", "ChangeRecordDetailDescription": "string", "ChgRecdExpectedCompletionDate": "/Date(1492041600000)/" } }`
Connection
Change Record UUID	NodeID

{
 "d": {
 "ChangeRecord": "string",
 "ChangeRecordType": "string",
 "ChangeRecordStatus": "string",
 "ChangeNumber": "string",
 "ChangeRecordLifecycleStatus": "string",
 "Partner": "string",
 "ChgRecordDescriptionText": "string",
 "ChangeRecordDetailDescription": "string",
 "ChgRecdExpectedCompletionDate": "/Date(1492041600000)/"
 }
 }

Connection

Change Record UUID NodeID

Update Project

Updates the basic information for a customer or internal project.

Input Comments Default

Body

Request Body

Input	Comments	Default
Body	Request Body	{ "d": { "ProjectName": "string", "ProjectStage": "string", "Currency": "string", "StartDate": "/Date(1492098664000)/", "EndDate": "/Date(1492098664000)/", "ProjManagerExtId": "string", "ProjManagerCompCode": "string", "ProfitCenter": "string", "ProjAccountantExtId": "string", "ProjAccountantCompCode": "string", "ProjControllerExtId": "string", "ProjControllerCompCode": "string", "ProjPartnerExtId": "string", "ProjPartnerCompCode": "string", "ProjectDesc": "string", "Confidential": "string", "UseProjectBilling": "string", "RestrictTimePosting": "string" } }
Connection
Project ID	Project ID

{
 "d": {
 "ProjectName": "string",
 "ProjectStage": "string",
 "Currency": "string",
 "StartDate": "/Date(1492098664000)/",
 "EndDate": "/Date(1492098664000)/",
 "ProjManagerExtId": "string",
 "ProjManagerCompCode": "string",
 "ProfitCenter": "string",
 "ProjAccountantExtId": "string",
 "ProjAccountantCompCode": "string",
 "ProjControllerExtId": "string",
 "ProjControllerCompCode": "string",
 "ProjPartnerExtId": "string",
 "ProjPartnerCompCode": "string",
 "ProjectDesc": "string",
 "Confidential": "string",
 "UseProjectBilling": "string",
 "RestrictTimePosting": "string"
 }
 }

Connection

Project ID Project ID

Update Purchase Requisition

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

Updates an existing record in SAP S/4HANA.

Input	Comments	Default
Body	Request Body	`{ "BusEventSubscriberCode": "string", "SAPObjectType": "string", "SAPObjectTaskCode": "string", "BusEventSubscriptionStateCode": "string", "BusEventPriority": 0 }`
Connection
Record Type	Type of SAP S/4HANA Record, e.g: WorkItemSet	WorkItemSet
Record ID	ID number tied to the record	12312313

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.

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	`{ "d": { "BusEventSubscriptionStateCode": "s", "BusEventPriority": 0 } }`
Connection

Update Timesheet Entry Collection

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

Input Comments Default

Body

Request Body

Input	Comments	Default
Body	Request Body	{ "TimeSheetDataFields": { "ControllingArea": "string", "SenderCostCenter": "string", "ReceiverCostCenter": "string", "InternalOrder": "string", "ActivityType": "string", "WBSElement": "string", "WorkItem": "string", "BillingControlCategory": "string", "PurchaseOrder": "string", "PurchaseOrderItem": "string", "TimeSheetTaskType": "string", "TimeSheetTaskLevel": "string", "TimeSheetTaskComponent": "string", "TimeSheetNote": "string", "RecordedHours": "0", "RecordedQuantity": "0", "HoursUnitOfMeasure": "string", "RejectionReason": "string", "TimeSheetWrkLocCode": "string", "TimeSheetOvertimeCategory": "string", "SenderPubSecFund": "string", "SendingPubSecFunctionalArea": "string", "SenderPubSecGrant": "string", "SenderPubSecBudgetPeriod": "string", "ReceiverPubSecFund": "string", "ReceiverPubSecFuncnlArea": "string", "ReceiverPubSecGrant": "string", "ReceiverPubSecBudgetPeriod": "string" }, "PersonWorkAgreementExternalID": "string", "CompanyCode": "string", "TimeSheetRecord": "string", "PersonWorkAgreement": "string", "TimeSheetDate": "/Date(1492098664000)/", "TimeSheetIsReleasedOnSave": true, "TimeSheetPredecessorRecord": "string", "TimeSheetStatus": "string", "TimeSheetIsExecutedInTestRun": true, "TimeSheetOperation": "string" }
Connection

{
 "TimeSheetDataFields": {
 "ControllingArea": "string",
 "SenderCostCenter": "string",
 "ReceiverCostCenter": "string",
 "InternalOrder": "string",
 "ActivityType": "string",
 "WBSElement": "string",
 "WorkItem": "string",
 "BillingControlCategory": "string",
 "PurchaseOrder": "string",
 "PurchaseOrderItem": "string",
 "TimeSheetTaskType": "string",
 "TimeSheetTaskLevel": "string",
 "TimeSheetTaskComponent": "string",
 "TimeSheetNote": "string",
 "RecordedHours": "0",
 "RecordedQuantity": "0",
 "HoursUnitOfMeasure": "string",
 "RejectionReason": "string",
 "TimeSheetWrkLocCode": "string",
 "TimeSheetOvertimeCategory": "string",
 "SenderPubSecFund": "string",
 "SendingPubSecFunctionalArea": "string",
 "SenderPubSecGrant": "string",
 "SenderPubSecBudgetPeriod": "string",
 "ReceiverPubSecFund": "string",
 "ReceiverPubSecFuncnlArea": "string",
 "ReceiverPubSecGrant": "string",
 "ReceiverPubSecBudgetPeriod": "string"
 },
 "PersonWorkAgreementExternalID": "string",
 "CompanyCode": "string",
 "TimeSheetRecord": "string",
 "PersonWorkAgreement": "string",
 "TimeSheetDate": "/Date(1492098664000)/",
 "TimeSheetIsReleasedOnSave": true,
 "TimeSheetPredecessorRecord": "string",
 "TimeSheetStatus": "string",
 "TimeSheetIsExecutedInTestRun": true,
 "TimeSheetOperation": "string"
 }

Connection

API Documentation​

Connections​

API Key (Sandbox)​

Prerequisites​

Setup Steps​

Configure the Connection​

Basic Auth​

Prerequisites​

Setup Steps in SAP S/4HANA Cloud​

Configure the Connection​

OAuth 2.0 Authorization Code​

Prerequisites​

Setup Steps in SAP S/4HANA Cloud​

Configure the Connection​

Authorization Flow​

Actions​

Add Attachment​

Add Item To Purchase Requisition​

Create Change Record​

Create Project​

Create Purchase Requisition​

Create Record​

Create Subscription​

Delete Attachment​

Delete Record​

Get Attachment​

Get Change Records​

Get Project​

Get Purchase Requisition​

Get Purchase Requisition Item Details​

Get Record​

List Change Records​

List Files​

List Projects​

List Purchase Requisitions​

List Records​

List Subscriptions​

List Timesheet Entry Collection​

Raw Request​

Raw Request - OData​

Update Change Record​

Update Project​

Update Purchase Requisition​

Update Record​

Update Subscription​

Update Timesheet Entry Collection​

API Documentation

Connections

API Key (Sandbox)

Prerequisites

Setup Steps

Configure the Connection

Basic Auth

Prerequisites

Setup Steps in SAP S/4HANA Cloud

Configure the Connection

OAuth 2.0 Authorization Code

Prerequisites

Setup Steps in SAP S/4HANA Cloud

Configure the Connection

Authorization Flow

Actions

Add Attachment

Add Item To Purchase Requisition

Create Change Record

Create Project

Create Purchase Requisition

Create Record

Create Subscription

Delete Attachment

Delete Record

Get Attachment

Get Change Records

Get Project

Get Purchase Requisition

Get Purchase Requisition Item Details

Get Record

List Change Records

List Files

List Projects

List Purchase Requisitions

List Records

List Subscriptions

List Timesheet Entry Collection

Raw Request

Raw Request - OData

Update Change Record

Update Project

Update Purchase Requisition

Update Record

Update Subscription

Update Timesheet Entry Collection